jambonz-feature-server/lib/http-routes/api/create-call.js

const router = require('express').Router();
const makeTask = require('../../tasks/make_task');
const RestCallSession = require('../../session/rest-call-session');
const CallInfo = require('../../session/call-info');
const {CallDirection, CallStatus} = require('../../utils/constants');
const { v4: uuidv4 } = require('uuid');
const SipError = require('drachtio-srf').SipError;
const sysError = require('./error');
const HttpRequestor = require('../../utils/http-requestor');
const WsRequestor = require('../../utils/ws-requestor');
const RootSpan = require('../../utils/call-tracer');
const dbUtils = require('../../utils/db-utils');

router.post('/', async(req, res) => {
  const {logger} = req.app.locals;

  logger.debug({body: req.body}, 'got createCall request');
  try {
    let uri, cs, to;
    const restDial = makeTask(logger, {'rest:dial': req.body});
    const {srf} = require('../../..');
    const {lookupAccountDetails} = dbUtils(logger, srf);
    const {getSBC, getFreeswitch} = srf.locals;
    const sbcAddress = getSBC();
    if (!sbcAddress) throw new Error('no available SBCs for outbound call creation');
    const target = restDial.to;
    const opts = {
      callingNumber: restDial.from,
      headers: req.body.headers || {}
    };


    const {lookupTeamsByAccount, lookupAccountBySid} = srf.locals.dbHelpers;
    const account = await lookupAccountBySid(req.body.account_sid);
    const accountInfo = await lookupAccountDetails(req.body.account_sid);
    const callSid = uuidv4();

    opts.headers = {
      ...opts.headers,
      'X-Jambonz-Routing': target.type,
      'X-Jambonz-FS-UUID': srf.locals.fsUUID,
      'X-Call-Sid': callSid,
      'X-Account-Sid': req.body.account_sid
    };

    switch (target.type) {
      case 'phone':
      case 'teams':
        uri = `sip:${target.number}@${sbcAddress}`;
        to = target.number;
        if ('teams' === target.type) {
          const obj = await lookupTeamsByAccount(req.body.account_sid);
          if (!obj) throw new Error('dial to ms teams not allowed; account must first be configured with teams info');
          Object.assign(opts.headers, {
            'X-MS-Teams-FQDN': obj.ms_teams_fqdn,
            'X-MS-Teams-Tenant-FQDN': target.tenant || obj.tenant_fqdn
          });
          if (target.vmail === true) uri = `${uri};opaque=app:voicemail`;
        }
        break;
      case 'user':
        uri = `sip:${target.name}`;
        to = target.name;
        if (target.overrideTo) {
          Object.assign(opts.headers, {
            'X-Override-To': target.overrideTo
          });
        }
        break;
      case 'sip':
        uri = target.sipUri;
        to = uri;
        break;
    }

    if (target.type === 'phone' && target.trunk) {
      const {lookupCarrier} = dbUtils(this.logger, srf);
      const voip_carrier_sid = await lookupCarrier(req.body.account_sid, target.trunk);
      this.logger.info(
        `createCall: selected ${voip_carrier_sid} for requested carrier: ${target.trunk || 'unspecified'})`);
      if (voip_carrier_sid) {
        opts.headers['X-Requested-Carrier-Sid'] = voip_carrier_sid;
      }
    }


    /* create endpoint for outdial */
    const ms = getFreeswitch();
    if (!ms) throw new Error('no available Freeswitch for outbound call creation');
    const ep = await ms.createEndpoint();
    logger.debug(`createCall: successfully allocated endpoint, sending INVITE to ${sbcAddress}`);

    /* launch outdial */
    let sdp, sipLogger;
    const connectStream = async(remoteSdp) => {
      if (remoteSdp !== sdp) {
        ep.modify(sdp = remoteSdp);
        return true;
      }
      return false;
    };
    Object.assign(opts, {
      proxy: `sip:${sbcAddress}`,
      localSdp: ep.local.sdp
    });
    if (target.auth) opts.auth = this.target.auth;


    /**
     * create our application object -
     * not from the database as per an inbound call,
     * but from the provided params in the request
     */
    const app = req.body;

    /**
     * attach our requestor and notifier objects
     * these will be used for all http requests we make during this call
     */
    if ('WS' === app.call_hook?.method) {
      app.requestor = new WsRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret) ;
      app.notifier = app.requestor;
    }
    else {
      app.requestor = new HttpRequestor(logger, account.account_sid, app.call_hook, account.webhook_secret);
      if (app.call_status_hook) app.notifier = new HttpRequestor(logger, account.account_sid, app.call_status_hook,
        account.webhook_secret);
      else app.notifier = {request: () => {}};
    }

    /* now launch the outdial */
    try {
      const dlg = await srf.createUAC(uri, {...opts,  followRedirects: true, keepUriOnRedirect: true}, {
        cbRequest: (err, inviteReq) => {
          /* in case of 302 redirect, this gets called twice, ignore the second */
          if (res.headersSent) return;

          if (err) {
            logger.error(err, 'createCall Error creating call');
            res.status(500).send('Call Failure');
            return;
          }
          inviteReq.srf = srf;
          /* ok our outbound INVITE is in flight */

          const tasks = [restDial];
          const rootSpan = new RootSpan('rest-call', req);
          const callInfo = new CallInfo({
            direction: CallDirection.Outbound,
            req: inviteReq,
            to,
            tag: app.tag,
            callSid,
            accountSid: req.body.account_sid,
            applicationSid: app.application_sid,
            traceId: this.rootSpan.traceId
          });
          cs = new RestCallSession({
            logger,
            application: app,
            srf,
            req: inviteReq,
            ep,
            tasks,
            callInfo,
            accountInfo,
            rootSpan
          });
          cs.exec(req);

          res.status(201).json({sid: cs.callSid});

          sipLogger = logger.child({
            callSid: cs.callSid,
            callId: callInfo.callId
          });
          sipLogger.info(`outbound REST call attempt to ${JSON.stringify(target)} has been sent`);
        },
        cbProvisional: (prov) => {
          const callStatus = prov.body ? CallStatus.EarlyMedia : CallStatus.Ringing;
          if ([180, 183].includes(prov.status) && prov.body) connectStream(prov.body);
          restDial.emit('callStatus', prov.status, !!prov.body);
          cs.emit('callStatusChange', {callStatus, sipStatus: prov.status});
        }
      });
      connectStream(dlg.remote.sdp);
      cs.emit('callStatusChange', {
        callStatus: CallStatus.InProgress,
        sipStatus: 200,
        sipReason: 'OK'
      });
      restDial.emit('callStatus', 200);
      restDial.emit('connect', dlg);
    }
    catch (err) {
      let callStatus = CallStatus.Failed;
      if (err instanceof SipError) {
        if ([486, 603].includes(err.status)) callStatus = CallStatus.Busy;
        else if (487 === err.status) callStatus = CallStatus.NoAnswer;
        if (sipLogger) sipLogger.info(`REST outdial failed with ${err.status}`);
        else console.log(`REST outdial failed with ${err.status}`);
        if (cs) cs.emit('callStatusChange', {
          callStatus,
          sipStatus: err.status,
          sipReason: err.reason
        });
      }
      else {
        if (cs) cs.emit('callStatusChange', {
          callStatus,
          sipStatus: 500,
          sipReason: 'Internal Server Error'
        });
        if (sipLogger) sipLogger.error({err}, 'REST outdial failed');
        else console.error(err);
      }
      ep.destroy();
    }
  } catch (err) {
    sysError(logger, res, err);
  }
});

module.exports = router;