Voximplant telephony integration

Incoming calls

For incoming calls, you need to implement additional features in your Voximplant app script and create a trigger in Usedesk. You can learn more about this in the documentation for developers following the link.

The Usedesk library for working with tickets

Create a new script with an arbitrary name and insert the following code:

function jsonRequest(url, cb, opt) {
    opt = opt || {};
    opt.headers = opt.headers || [];
    opt.headers.push('Content-type: application/json');
    if('json' in opt) {
        opt.postData = JSON.stringify(opt.json);
    }
    Net.httpRequest(url, cb, opt);
}
class SafeJson {
    static parse(raw) {
        try {
            return JSON.parse(raw);
        }catch(e) {
            return null;
        }
    }
}
class Usedesk {
    constructor(token, baseUrl = '<https://api.usedesk.ru>') {
        this.token = token;
        this.baseUrl = baseUrl;
    }
    createTicket(data) {
        data.api_token = this.token;
        return new Promise((resolve) => {
            jsonRequest(
                this.baseUrl + '/create/ticket', 
                ({text}) => {
                    const maybeJson = SafeJson.parse(text);
                    const result = maybeJson && 'ticket_id' in maybeJson ? maybeJson.ticket_id : -1;
                    resolve(result);
                }, 
                {method: 'POST', json: data}
            )
        })
    }
    createComment(ticketId, message) {
        const data = {
            api_token: this.token,
            ticket_id: ticketId,
            message: message,
            type: "private"
        }
        return new Promise(resolve => {
            jsonRequest(
                this.baseUrl + '/create/comment',
                ({text}) => {
                    const maybeJson = SafeJson.parse(text);
                    const result = !!maybeJson && 'comment_id' in maybeJson;
                    resolve(result);
                },
                {method: 'POST', json: data}
            )
        })
    }
}
	

Important! If you use the Usedesk on-premise version on your own server, your baseUrl will be different. Check the URL to work with the API, contacting our support — support@usedesk.com.

Implementing the library into the script

1) In the script you need to define the global constant TOKEN with your API token value and define Usedesk. How to get the token, is explained in the article at the link.

const TOKEN = 'Your Usedesk API token';
const usedesk = new Usedesk(TOKEN);
	

2) When a call is successful, the CallEvents.Connected callback is executed. Thus, when a connection is established, a ticket should be created in Usedesk. Below is an example of a piece of code that will create a ticket in a channel, specified in the channel_id parameter, with the following data:

• A ticket subject: a new call with an agent %a login user in Voximplant%;
• A message in a ticket: a new successful call from a number %a client number%;
• A ticket will be bound to a client with a name %a client number%, a number will be added to a card.

inc.addEventListener(CallEvents.Connected, <<<<<<<<$1>$1>$1>$1>$1>$1>$1>$1> () => {
      sessionTicketId = await usedesk.createTicket({
        subject: "New call with agent " + inc.username(),
        message: "New successful call from the number " + inc.callerid(),
        client_name: inc.callerid(),
        client_phone: inc.callerid(),
        channel_id: 12345
      })
  })<<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1><<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></<$1>$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1></$1>
    
	

3) You can also add a processor for the cases, when a connection fails for some reasons:

inc.addEventListener(CallEvents.Disconnected, <<<<<<<$1>$1>$1>$1>$1>$1>$1> () => {
    if(sessionTicketId > 0) {
      await usedesk.createComment(sessionTicketId, 'Failed to connect');
    }
  });
});<<$1>$1><<$1>$1><<$1>$1>    </<$1>$1></<$1>$1></<$1>$1></<$1>$1></$1></$1></$1></$1></$1></$1></$1></$1>
    
	

Creating triggers in Usedesk

In Usedesk you can use triggers to match a user in Voximplant with an agent in Usedesk. Below there is an example of the trigger, when calls for the Voximplant user with the nickname Smith will be assigned to the agent Neo in Usedesk:

Was the article helpful?

Thanks for the feedback!

Advise how to improve the article

Thanks for the feedback!