InteractionLog object allows users to manage different interactions in Maximizer CRM.
An interaction refers to any form of communication or engagement with a customer, such as calls, emails, or other custom touchpoints.
Below are some considerations for interactions:
-
The Type field defines the kind of interaction. There are default options like "Phone Call" or "Email," but custom ones can also be created. Check the field options to see the available types.\
-
To tie an interaction to an AbEntry, set the AbEntryKey field with the key of the related AbEntry.\
-
To tie an interaction to a Lead, set the LeadKey field with the key of the related Lead.\
-
To tie an interaction to an Opportunity, set the WithKey field with the key of the related Opportunity. Additionally, ensure that either AbEntryKey or LeadKey is set, depending on whether the Opportunity is tied to an AbEntry or a Lead.\
-
Some fields like Result or Category have customizable values, check the field options to see the available ones.
HowTo's
Read - Get last 3 phone call logs for AbEntry
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"Scope": {
"Fields": {
"Key": 1,
"Type": 1,
"Description": 1,
"Subject": 1,
"StartDate": 1,
"Duration": 1,
"User": 1,
"AbEntry": 1
}
},
"Criteria": {
"SearchQuery": {
"$AND": [
{
"Type": {
"$IN": [
"60001" // Phone Call
]
}
},
{
"AbEntryKey": {
"$EQ": "QWJFbnRyeQlERU1PXzVDCTE=" // Key of the AbEntry you want to serch interactions for
}
}
]
},
"Top": 3
},
"OrderBy": {
"Fields": [
{
"StartDate": "DESC"
}
]
}
}
}Read - Get total phone call logs for Opportunity
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"Scope": {
"Fields": {
"$COUNT()": 1
}
},
"Criteria": {
"SearchQuery": {
"$AND": [
{
"Type": {
"$IN": [
"60001" // Phone Call
]
}
},
{
"WithKey": {
"$EQ": "T3Bwb3J0dW5pdHkJT1BQX0RFTU9fMQkw" // Key of the Opportunity you want to serch interactions for
}
}
]
}
}
}
}Read - Get total phone call duration for Opportunities
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"Scope": {
"Fields": {
"$SUM(Duration)": 1
}
},
"Criteria": {
"SearchQuery": {
"$AND": [
{
"Type": {
"$IN": [
"60001" // Phone Call
]
}
},
{
"WithKey": {
"$EQ": "T3Bwb3J0dW5pdHkJT1BQX0RFTU9fMQkw" // Key of the Opportunity you want to serch interactions for
}
}
]
}
}
}
}Read - Get total number of phone call logs
Use the AbEntryRead method to search for Address Book entries in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"Scope": {
"Fields": {
"$COUNT()": 1
}
},
"Criteria": {
"SearchQuery": {
"Type": {
"$IN": [
"60001" // Phone Call
]
}
}
}
}
}Metadata
Read InteractionLog metadata (simple)
Use the SchemaRead method to query the structure or metadata of entities in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": 1
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/InteractionLog"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read InteractionLog metadata (more)
Use the SchemaRead method to query the structure or metadata of entities in the database.
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": {
"Key": 1,
"Alias": 1,
"Type": 1,
"Name": 1,
"AppliesTo": 1,
"Sortable": 1,
"Queryable": 1,
"Mandatory": 1,
"Attributes": 1,
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/InteractionLog"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}FieldOptions
Read InteractionLog FieldOptions - Type
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"FieldOptions": {
"Type": [
{
"Key": 1,
"Value": 1,
"Name": 1,
"DisplayValue": 1,
"Icon": 1,
"BiDirectional": 1,
"External": 1
}
]
}
}
}Read InteractionLog FieldOptions - Category
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"FieldOptions": {
"Category": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
}
}Read InteractionLog FieldOptions - Result
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"FieldOptions": {
"Result": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
}
}InteractionLog CRUD
Create - InteractionLog (Assigned to Opportunity)
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"InteractionLog": {
"Data": {
"Key": null,
"Source": "604-600-1234",
"Subject": "Test Phone Call Interaction (Assigned to Opportunity)",
"Description": "This is a test interaction representing a phone call for an Opportunity",
// Check field options to see Type available options
"Type": "60001",
"StartDate": "2024-01-20T10:00:01",
"EndDate": "2024-01-20T10:10:10",
"User": "$CURRENTUSER()",
// WithKey must always be specified together with AbEntryKey or LeadKey
"WithKey": "T3Bwb3J0dW5pdHkJMjQwNTI4MjUwOTE4NTU1MTUwMDAyTwkw", // Opportunity Key
"LeadKey": "TGVhZAkyMzA5MTEwMDAwMTEzMTk3MTY1MzFMRQkw",
// Check field options to see Result available options
"Result": "10",
// 1 = Incoming, 2 = Outgoing
"Direction": 1,
// Check field options to see Category available options
"Category": "1"
}
}
}Create - InteractionLog (Assigned to AbEntry)
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"InteractionLog": {
"Data": {
"Key": null,
"Source": "604-600-1234",
"Subject": "Test Phone Call Interaction (Assigned to AbEntry)",
"Description": "This is a test interaction representing a phone call for AbEntry",
// Check field options to see Type available options
"Type": "60001",
"StartDate": "2024-01-20T10:00:01",
"EndDate": "2024-01-20T10:10:10",
"User": "$CURRENTUSER()",
"AbEntryKey": "Q29tcGFueQkyMjA3MTMyNTAzMDMwNTg2NzAwMDVDCTA=",
// Check field options to see Result available options
"Result": "10",
// 1 = Incoming, 2 = Outgoing
"Direction": 1,
// Check field options to see Category available options
"Category": "1"
}
}
}Create - InteractionLog (Assigned to Lead)
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"InteractionLog": {
"Data": {
"Key": null,
"Source": "604-600-1234",
"Subject": "Test Phone Call Interaction (Assigned to Lead)",
"Description": "This is a test interaction representing a phone call for Lead",
// Check field options to see Type available options
"Type": "60001",
"StartDate": "2024-01-20T10:00:01",
"EndDate": "2024-01-20T10:10:10",
"User": "$CURRENTUSER()",
"LeadKey": "TGVhZAkyMjA3MTMwMDAwODA3NzIyMzgxNjlMRQkw",
// Check field options to see Result available options
"Result": "10",
// 1 = Incoming, 2 = Outgoing
"Direction": 1,
// Check field options to see Category available options
"Category": "1"
}
}
}Read - InteractionLog
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"InteractionLog": {
"Scope": {
"Fields": {
"Key": 1,
"Subject": 1,
"Description": 1,
"User": 1,
"Source": 1,
"StartDate": 1,
"EndDate": 1,
"AbEntry": 1,
"Lead": 1,
"WithKey": 1,
"Duration": 1,
"Direction": 1,
"Data": 1
}
},
"Criteria": {
"SearchQuery": {},
"Top": 3
}
}
}Update - InteractionLog
// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
"InteractionLog": {
"Data": {
"Key": "SW50ZXJhY3Rpb25Mb2cJMjQwOTIwMDAwMDAwMDAxMTU2Nzk5SUwJMA==", // Mandatory
"Source": "Test Phone Call Interaction Updated",
"Subject": "This is an updated test interaction representing a phone call",
"Result": "11",
"Category": "2",
"Direction": 2
}
}
}Delete - InteractionLog
// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
"InteractionLog": {
"Data": {
"Key": "SW50ZXJhY3Rpb25Mb2cJMjIwNzEzMDAwMDQwNzcyMjM4MTY5SUwJMA==" // Mandatory
}
}
}