getCallLog

This interface retrieves a previously logged call log record in the target CRM. This information is used to render a form to allow an end user to view or edit that record within the App Connect client.

Request parameters

Parameter	Description
user	TODO
callLogId	The ID of the activity or call log record within the CRM.
authHeader	The HTTP Authorization header to be transmitted with the API request to the target CRM.

Return value(s)

This interface should return the associated call log record in a prescribed format.

Parameter	Description
callLogInfo	Contain subject, note and optionally additionalSubmission
returnMessage	message, messageType and ttl

Example

{
  callLogInfo:{
    subject: "A new call from John Doe",
    note: "Delivery location changed.",
    additionalSubmission: {
      address: "12 Some Street, CA"
    }
  },
  returnMessage:{
    message: 'Log fetched',
    messageType: 'success', // 'success', 'warning' or 'danger'
    ttl: 30000 // in miliseconds
  }
}

Reference

Example CRMPipedrive

async function getCallLog({ user, callLogId, authHeader }) {
    const path = require('path');
    const mockCallLogsPath = path.join(__dirname, '..', 'mockCallLogs.json');
    const mockCallLogs = require(mockCallLogsPath);
    const callLog = mockCallLogs.find(callLog => callLog.id === callLogId);
    const subject = callLog.subject;
    const note = callLog.note ? callLog.note.split('- Note: ')[1].split('\n')[0] : '';
    //-------------------------------------------------------------------------------------
    //--- CHECK: In extension, for a logged call, click edit to see if info is fetched ----
    //-------------------------------------------------------------------------------------

    //--------------------------------------
    //--- TODO: Add CRM API call here ------
    //--- TODO: Delete above mock JSON -----
    //--------------------------------------
    // const getLogRes = await axios.get(
    //     `https://api.crm.com/activity/${callLogId}`,
    //     {
    //         headers: { 'Authorization': authHeader }
    //     });
    return {
        callLogInfo: {
            subject,
            note,
            fullBody: callLog.note,
            dispositions: {
                testDispositionId: 'test disposition value'
            }
        },
        returnMessage: {
            message: 'Call log fetched.',
            messageType: 'success',
            ttl: 3000
        }
    }
}

module.exports = getCallLog;

async function getCallLog({ user, callLogId, authHeader }) {
    let extraDataTracking = {};
    const getLogRes = await axios.get(
        `https://${user.hostname}/api/v2/activities/${callLogId}`,
        {
            headers: { 'Authorization': authHeader }
        });
    extraDataTracking = {
        ratelimitRemaining: getLogRes.headers['x-ratelimit-remaining'],
        ratelimitAmount: getLogRes.headers['x-ratelimit-limit'],
        ratelimitReset: getLogRes.headers['x-ratelimit-reset']
    };
    const logBody = getLogRes.data.data.note;
    const note = logBody.split('<b>Agent notes</b>')[1]?.split('<b>Call details</b>')[0]?.replaceAll('<br>', '') ?? '';
    const relatedContact = getLogRes.data.related_objects?.person;
    let contactName = 'Unknown';
    if (relatedContact) {
        const contactKeys = Object.keys(relatedContact);
        contactName = relatedContact[contactKeys[0]].name;
    }
    return {
        callLogInfo: {
            subject: getLogRes.data.data.subject,
            note,
            contactName,
            fullBody: logBody,
            fullLogResponse: getLogRes?.data?.data,
            dispositions: {
                deals: getLogRes.data.data.deal_id,
                leads: getLogRes.data.data.lead_id
            }
        },
        extraDataTracking
    }
}