README.md

nethcti-server

It is a daemon that provides a set of api to perform common switchboard operations and a websocket streaming channel to listen for the events.

Actually it supports only Asterisk PBX.

Index

• How to use
• Documentation
• Authentication
  • Login
  • Logout
  • Disabling
• REST API
• Reconnections
• CORS
• WebSocket Events
• Logging

How to use

To launch it manually copy all the server content into the path:

cp root/usr/lib/node/nethcti-server /usr/lib/node/

install all npm packages:

cd /usr/lib/node/nethcti-server
/usr/bin/scl enable rh-nodejs10 "npm install"

then launch the daemon:

/usr/bin/scl enable rh-nodejs10 "npm start"

You can easily enable info logging level setting environment variable:

NODE_ENV=development

Documentation

https://nethvoice.docs.nethesis.it/it/v14/

Authentication

Login

To obtain the nonce you have to do:

POST /authentication/login

with the following body in JSON format:

{
  "username": "<username>",
  "password": "<password>"
}

If the authentication is successfully you get the following:

HTTP 401

www-authenticate Digest 6e4fed102e96e9f408d53ebfab889c5ded22acb3

The digest is the nonce by which you calculate the token that will be used for any rest api call.

To calculate the token use the following algorithm:

tohash = username + ':' + password + ':' + nonce
token  = HMAC-SHA1(tohash, password)

The token expires after 30 minutes if not used.

Logout

To logout you have to do:

POST /authentication/logout

Disabling

To disable the authentication:

config setprop nethcti AuthenticationEnabled false
config setprop nethcti-server AuthenticationEnabled false
signal-event nethcti3-update
signal-event nethcti-server3-update

at this point you can login to NethCTI only using the username.

To re-enable it:

config setprop nethcti AuthenticationEnabled true
config setprop nethcti-server AuthenticationEnabled true
signal-event nethcti3-update
signal-event nethcti-server3-update

REST API

Each request must contain the authentication token retrieved as described above. It must be specified in the HTTP Header of the request:

Authorization: <username>:token

Reconnections

Websocket reconnections are fundamental to keep cti services up.

A key concept is the reconnection delay to keep safe the server from possible connections flood.

As you can see from the following url https://github.com/socketio/socket.io-client/blob/master/docs/API.md#managerurl-options socket io client is set to reconnect automatically for default up to infinity with a randomized initial delay. Each attempt increases the reconnection delay by 2x along with a randomization as above.

CORS

CORS are allowed.

WebSocket Events

userPresenceUpdate

Logging

The daemon logs on

/var/log/asterisk/nethcti.log

NethCTI CLI

root/usr/lib/node/nethcti-server/nethcti-cli.js it's a command line interface to communicate with the nethcti-server.

It uses the /run/nethvoice/nethcti.sock IPC to communicate.

To show the command's help message, execute the script without arugments:

scl enable rh-nodejs10 'node /usr/lib/node/nethcti-server/nethcti-cli'