InteractionApi

Communicate to Five9 adapter that user pressed phone number and wants to initiate click to dial. call will be started automatically if default campaign is configured by administrator or campaign name is provided in click2dialData parameter.

const interactionApi = window.Five9.CrmSdk.interactionApi();
interactionApi.click2dial({
  click2DialData: {
    clickToDialNumber: "9250000111",
    crmObject: {id: "789", label: "Account", name: "Umbrella", isWho: false, isWhat: true}
  }
});

Executes REST request using CORS

interactionApi.executeRestApi({path: '/appsvcs/rs/svc/orgs/1/dispositions', method: 'GET', payload: null}).then(function (result) {
  // resolve handler
}, function (result) {
  // reject handler
});

Executes REST request using Five9 Rest Api from adapter

interactionApi.executeRestApi({path: '/appsvcs/rs/svc/orgs/1/dispositions', method: 'GET', payload: null}).then(function (result) {
  // resolve handler
}, function (result) {
  // reject handler
});

Retrieves list of call attached variables

interactionApi.subscribe({
  callStarted: params => {
    interactionApi.getCav({interactionId: params.callData.interactionId})
      .then(cavList => {
        console.debug('Interaction API got cavList: ' + JSON.stringify(cavList));
      });
  }
});

Retrieves list of VCC contact record fields

interactionApi.subscribe({
  callStarted: params => {
    interactionApi.getCrm({interactionId: params.callData.interactionId})
      .then(crmList => {
        console.debug('Interaction API got crmList: ' + JSON.stringify(crmList));
      });
  }
});

Retrieves list of dispositions for specified interaction

interactionApi.subscribe({
  callStarted: params => {
    interactionApi.getDispositions({interactionType: 'Call', interactionId: params.callData.interactionId})
      .then(dispositionList => {
        console.debug('Interaction API got dispositionList: ' + JSON.stringify(dispositionList));
      });
  }
});

Retrieves of agent and tenant ids

Retrieves list of visited 'Name' CRM objects for specified interaction

interactionApi.subscribe({
  objectSelected: params => {
    interactionApi.getNameObjects({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId
    }).then(objects => {
      console.debug('Interaction API got name objects: ' + JSON.stringify(objects));
    });
  }
});

Retrieves list of visited 'Related To' CRM objects for specified interaction

interactionApi.subscribe({
  objectSelected: params => {
    interactionApi.getRelatedToObjects({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId
    }).then(objects => {
      console.debug('Interaction API got related to objects: ' + JSON.stringify(objects));
    });
  }
});

Retrieves list of CRM objects found by search

interactionApi.subscribe({
  callEnded: params => {
    interactionApi.getSearchResults({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId
    }).then(searchResults => {
      console.debug('Interaction API got searchResults: ' + JSON.stringify(searchResults));
    });
  }
});

Retrieves selected 'Name' CRM object for specified interaction

interactionApi.subscribe({
  callEnded: params => {
    interactionApi.getSelectedNameObject({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId
    }).then(nameObject => {
      console.debug('Interaction API got selected name object: ' + JSON.stringify(nameObject));
    });
  }
});

Retrieves selected 'Related To' CRM object for specified interaction

interactionApi.subscribe({
  callEnded: params => {
    interactionApi.getSelectedRelatedToObject({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId
    }).then(relatedToObject => {
      console.debug('Interaction API got selected related to object: ' + JSON.stringify(relatedToObject));
    });
  }
});

Determines if this page contains ADT instance which holds websocket connection

Mute softphone.

Communicate details of object visited by user in CRM system to Five9 Agent Desktop toolkit. Five9 adapter will display this object in the list of objects available for saving call logs.

const interactionApi = window.Five9.CrmSdk.interactionApi();
interactionApi.objectVisited({
  crmObject: {id: "456", label: "Case", name: "Broken microwave", isWho: false, isWhat: true}
});

Open screen for passed interaction.

interactionApi.openInteraction({
   interactionType: params.interactionType,
   interactionId: params.interactionId
}).then(() => {
   console.debug('Interaction API interaction opened');
});

Sets selected 'Name' CRM object for specified interaction

interactionApi.subscribe({
  callEnded: params => {
    interactionApi.selectNameObject({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId,
      objectId: '123'
    }).then(() => {
      console.debug('Interaction API set selected name object');
    });
  }
});

Sets selected 'Related To' CRM object for specified interaction

interactionApi.subscribe({
  callEnded: params => {
    interactionApi.selectRelatedToObject({
      interactionType: params.interactionType,
      interactionId: params.interactionData.interactionId,
      objectId: '123'
    }).then(() => {
      console.debug('Interaction API set selected related to object');
    });
  }
});

Send DTMF to softphone.

Sets value of call attached variables

interactionApi.setCav({
  interactionId: "45E471D607A94072A553A1406CC0BF03",
  cavList: [
    {id: "641", value: "test value"},
    {id:"219", value: "test@example.com"}
  ]
});

Sets disposition for current call

interactionApi.setDisposition({
  interactionType: 'Call',
  interactionId: "92544E7EFD1B4858A93C54092CB51886",
  dispositionId: "3558"
});

Subscribes to Interaction Api events.

const interactionApi = window.Five9.CrmSdk.interactionApi();
interactionApi.subscribe({
    callStarted: function (params) {
    },
    callFinished: function (params) {
    },
    callAccepted: function (params) {
    },
    callRejected: function (params) {
    },
    callEnded: function (params) {
    },
    emailOffered: function (params) {
    },
    emailAccepted: function (params) {
    },
    emailRejected: function (params) {
    },
    emailTransferred: function (params) {
    },
    emailFinished: function (params) {
    },
    chatOffered: function (params) {
    },
    chatAccepted: function (params) {
    },
    chatRejected: function (params) {
    },
    chatTransferred: function (params) {
    },
    chatEnded: function (params) {
    },
    chatFinished: function (params) {
    },
    objectSelected: function (params) {
    }
});

Subscribes to web socket events.

interactionApi.subscribeWsEvent({
    "29": function (params, context) {
    },
    "15": function (params, context) {
    },
    ...
});

alternative subscription:

interactionApi.subscribeWsEvent("29", function (params) {
});

Unmute softphone.

Unsubscribes from web socket events.

interactionApi.unsubscribeWsEvent({
    "29": <function used for subscription>,
    "15": <function used for subscription>,
    ...
});

alternative unsubscription:

interactionApi.unsubscribeWsEvent("29", <function used for subscription>);