To make things easier when building different Workflows in our Engagement Builder, we have a dedicated Macros section to help with standard fields in Kaisa related to your account.
There are multiple fields in the list, so we break them down for you below.
Email dedicated values
| Field | Placeholder | Description |
| Account Email | {{ sc_email }} | Stored Email address when the account was created. Can be modified in the Dashboard or via our rest API. |
| Notification Email Recipient | {{ legacyNotificationSettings.notificationEmailRecipient }} | Static numbers have a dedicated field for email addresses for notifications that can be used with the Engagement Builder |
SMS dedicated values
| Field | Placeholder | Description |
| End number | {{ end_nr }} | The real number receiving the call on the customer or dealer's end. |
| From number | {{ from_nr }} | This field contains the calling number |
| Local end number | {{ local_end_nr }} | The dealer's or destination number for the call, in local format |
| Local from number | {{ local_from_nr }} | The caller number in local format |
| Local to number | {{ local_to_nr }} | The Kaisa number in local format |
Notification SMS Recipient |
{{ legacyNotificationSettings.notificationSmsRecipient }} |
Static numbers have a dedicated field for a telephone number for notifications via sms that can be used with the Engagement Builder |
General values for Automotive customers
| Field | Placeholder | Description |
| Account name | {{ sc_name }} | Stored account name, as provided by the customer. Can be modified in the Dashboard or via our rest API. |
| Article ID | {{ article.id }} | Id value sent to Kaisa on a dynamic number request. Fields used are adId, propertyId, listingId or custom_101 |
| Article title | {{ article.props.title }} | Title value sent to Kaisa on a dynamic number request. Fields used are adTitle, adName or vehicleName |
| Browsing device | {{ session.device }} | The browsing device for the visitor, as captured by our javascript and the visitor session. For DNCS API see below* |
| Call Duration | {{ duration }} | The call duration in seconds |
| Call ID | {{ callid }} | The unique identifier for the caller (generated by our telco provider in a universal format) |
| Call Status | {{ call_status }} | The status of the call, as missed (0), dropped (1), short (2) or quality (3) |
| Callrecord ID | {{ id }} | The uniquely generated id for the call in Kaisa |
| Color | {{ article.props.color }} | Colour value sent to Kaisa on a dynamic number request. Field used is adColour. |
| Condition | {{ article.props.type }} | Condition value sent to Kaisa on a dynamic number request. Field used is adType. |
| Date local | {{ date_local }} | The full date for the phone call in local format. |
| Dealer location | {{ article.props.dealerArea }} | The dealer location passed on to Kaisa on a dynamic number request, using the field adDealerArea |
Electrical vehicle range |
{{ article.props.range }} | Range for an electrical vehicle, a value sent to Kaisa on a dynamic number request. Field used is adRange |
| End number | {{ end_nr }} | The real number receiving the call on the customer or dealer's end. |
| Engine power | {{ article.props.enginePower }} | Engine power value sent to Kaisa on a dynamic number request. Field used is adEnginePower. |
| Engine size | {{ article.props.engineSize }} | Engine size value sent to Kaisa on a dynamic number request. Field used is adEngineSize. |
| Fabrication year | {{ article.props.year }} | Vehicle year value sent to Kaisa on a dynamic number request. Field used is adYear |
| First visited URL | {{ session.first_visited_url }} | For visitor tracking setups, this will be the first page visited for this unique visitor |
| From number | {{ from_nr }} | This field contains the calling number |
| Fuel type | {{ article.props.fuelType }} | Fuel type value sent to Kaisa on a dynamic number request. Field used is adFuelType. |
| Geolocation | {{ session.geolocation }} | The geolocation of the caller, based on the user agent in the session or the calling number (if it is a geographical number). |
| Image URL | {{ article.props.imageUrl }} | The ad image url sent to Kaisa on a dynamic number request. Field used is adImageUrl. |
| Kaisa number | {{ to_nr }} | The Kaisa number in the call |
| Kaisa number name | {{ meas_name }} | The name for the Kaisa number called, based on the name for the Static number or the name given by our matching rules for dynamic numbers. |
| Last visited URL | {{ session.last_visited_url }} | For visitor tracking setups, this will be the last page visited for this unique visitor before they called the Kaisa number. |
| License plate | {{ article.props.license }} | The vehicle license plate sent to Kaisa on a dynamic number request. Field used is adLicense |
| Listing URL | {{ article.props.url }} | The ad url sent to Kaisa on a dynamic number request. Field used is adUrl. |
| Local end number | {{ local_end_nr }} | The dealer's or destination number for the call, in local format |
| Local from number | {{ local_from_nr }} | The caller number in local format |
| Local to number | {{ local_to_nr }} | The Kaisa number in local format |
| Media | {{ meas_media }} | The Medium for the Kaisa number, as generated in our end by our matching rules or manually entered (for Static numbers) |
| Mileage | {{ article.props.mileage }} | The vehicle mileage sent to Kaisa on a dynamic number request. Field used is adMileage. |
Notification Email Recipient |
{{ legacyNotificationSettings.notificationEmailRecipient }} |
Static numbers have a dedicated field for email addresses for notifications that can be used with the Engagement Builder |
Notification SMS Recipient |
{{ legacyNotificationSettings.notificationSmsRecipient }} |
Static numbers have a dedicated field for a telephone number for notifications via sms that can be used with the Engagement Builder |
| Number of doors | {{ article.props.noOfDoors }} | The vehicle number of doors sent to Kaisa on a dynamic number request. Field used is adDoors. |
| Price | {{ article.props.price }} | The vehicle price sent to Kaisa on a dynamic number request. Field used is adPrice. |
| Referred URL | {{ session.referrer_url }} | For visitor tracking setups, this will be the referrer url for this unique visitor, the page visited before their session started with Kaisa. |
| Start datetime | {{ start }} | The start time and date for the call in UTC. |
| Start local time | {{ time_local }} | The start time and date for the call in local time for the account. |
| UTM Campaign | {{ session.utm_campaign }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Content | {{ session.utm_content }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Medium | {{ session.utm_medium }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Source | {{ session.utm_source }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Term | {{ session.utm_term }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| Vehicle ID | {{ article.props.vehicleIdentificationNumber }} |
The vehicle ID sent to Kaisa on a dynamic number request. Field used is adVehicleIdentificationNumber. |
| Vehicle brand | {{ article.props.brand }} | The vehicle brand sent to Kaisa on a dynamic number request. Field used is adBrand. |
| Vehicle model | {{ article.props.model }} | The vehicle model sent to Kaisa on a dynamic number request. Field used is adModel. |
*For device data in DNCS API you can add {{ meas_mobile_user_agent }} which will return 0 for desktop, 1 for mobile and 2 for tablet (these are extracted from the userAgent value passed in the request to Kaisa.
General values for Real Estate customers
| Field | Placeholder | Description |
| Account name | {{ sc_name }} | Stored account name, as provided by the customer. Can be modified in the Dashboard or via our rest API. |
| Article ID | {{ article.id }} | Id value sent to Kaisa on a dynamic number request. Fields used are adId, propertyId, listingId or custom_101 |
| Article title | {{ article.props.title }} | Title value sent to Kaisa on a dynamic number request. Fields used are adTitle, adName or vehicleName |
| Browsing device | {{ session.device }} | The browsing device for the visitor, as captured by our javascript and the visitor session. For DNCS API see below* |
| Call Duration | {{ duration }} | The call duration in seconds |
| Call ID | {{ callid }} | The unique identifier for the caller (generated by our telco provider in a universal format) |
| Call Status | {{ call_status }} | The status of the call, as missed (0), dropped (1), short (2) or quality (3) |
| Callrecord ID | {{ id }} | The uniquely generated id for the call in Kaisa |
| Date local | {{ date_local }} | The full date for the phone call in local format. |
| End number | {{ end_nr }} | The real number receiving the call on the customer or dealer's end. |
| First visited URL | {{ session.first_visited_url }} | For visitor tracking setups, this will be the first page visited for this unique visitor |
| From number | {{ from_nr }} | This field contains the calling number |
| Geolocation | {{ session.geolocation }} | The geolocation of the caller, based on the user agent in the session or the calling number (if it is a geographical number). |
| Image URL | {{ article.props.imageUrl }} | The ad image url sent to Kaisa on a dynamic number request. Field used is adImageUrl. |
| Kaisa number | {{ to_nr }} | The Kaisa number in the call |
| Kaisa number name | {{ meas_name }} | The name for the Kaisa number called, based on the name for the Static number or the name given by our matching rules for dynamic numbers. |
| Last visited URL | {{ session.last_visited_url }} | For visitor tracking setups, this will be the last page visited for this unique visitor before they called the Kaisa number. |
| Listing URL | {{ article.props.url }} | The ad url sent to Kaisa on a dynamic number request. Field used is adUrl. |
| Local end number | {{ local_end_nr }} | The dealer's or destination number for the call, in local format |
| Local from number | {{ local_from_nr }} | The caller number in local format |
| Local to number | {{ local_to_nr }} | The Kaisa number in local format |
| Media | {{ meas_media }} | The Medium for the Kaisa number, as generated in our end by our matching rules or manually entered (for Static numbers) |
Notification Email Recipient |
{{ legacyNotificationSettings.notificationEmailRecipient }} |
Static numbers have a dedicated field for email addresses for notifications that can be used with the Engagement Builder |
Notification SMS Recipient |
{{ legacyNotificationSettings.notificationSmsRecipient }} |
Static numbers have a dedicated field for a telephone number for notifications via sms that can be used with the Engagement Builder |
| Price | {{ article.props.price }} | The listing price sent to Kaisa on a dynamic number request. Field used is adPrice. |
| Referred URL | {{ session.referrer_url }} | For visitor tracking setups, this will be the referrer url for this unique visitor, the page visited before their session started with Kaisa. |
| Start datetime | {{ start }} | The start time and date for the call in UTC. |
| Start local time | {{ time_local }} | The start time and date for the call in local time for the account. |
| UTM Campaign | {{ session.utm_campaign }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Content | {{ session.utm_content }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Medium | {{ session.utm_medium }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Source | {{ session.utm_source }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
| UTM Term | {{ session.utm_term }} | UTM value extracted from the landing url for visitor tracking setups with sessions. |
*For device data in DNCS API you can add {{ meas_mobile_user_agent }} which will return 0 for desktop, 1 for mobile and 2 for tablet (these are extracted from the userAgent value passed in the request to Kaisa.
Survey dedicated values
| Field | Placeholder | Description |
| Survey Question | {{ surveyResponses[N].question }} | The text of the question asked during the survey. Replace N with the index of the question (e.g., 0, 1, etc.). |
| Survey Answer | {{ surveyResponses[N].answer }} | The respondent’s answer to the question. Replace N with the index of the answer (e.g., 0, 1, etc.). |
Survey workflows also have access to values from the event that triggered the survey. These values can be added to the survey by using context:
{{ context.enterValueHere }}For example, to show the phone number of the respondent in the survey, it could be added as:
{{ context.from_nr }}Note: The available values depend on the payload of the event that triggered the survey (e.g., a call ends, form submission or any other custom event).
AI Agent dedicated values
| Field | Placeholder | Description |
| Agent email | {{ agentContactChannels.email }} | Stored email address for the dealer or agent |
| Agent phone | {{ agentContactChannels.phone }} | Stored phone number for the dealer or agent |
| Visitor email | {{ visitorContactChannels.email }} | Email address as captured by the AI agent for the visitor |
| Visitor Phone number | {{ visitorContactChannels.phone }} | Phone number of the caller, captured by the AI agent |
| Visitor name | {{ outcomeData.first_name }} | First name of the caller as captured by the AI agent for the visitor |
| Visitor last name | {{ outcomeData.last_name }} | Last name of the caller as captured by the AI agent for the visitor |
| Summary | {{ outcomeData.summary }} | AI generated summary of the call |
| AI agent type | {{ agentType }} | Kaisa AI agent type used (i.e. Out_of_hours agent) |
| Call Outcome | {{ outcome }} | Dropped, Engaged or Qualified * |
| Summary in original language | {{ summary.spokenLanguage }} | To see the call summary but as per the original language for the conversation. |
*Dropped -> the conversation didn't proceed beyond the initial greeting
Engaged -> the buyer and the AI exchanged at least 2 utterances
Qualified -> the AI managed to do its job and the store_form tool was called by the agent.
A word on custom parameters
Outside of the macros above, customers are free to send to Kaisa different custom values with our solution, following some of the instructions in this article. When doing so, you can add placeholders as well to be used in our Engagement Builder but using a different format.
As long as the parameters sent to Kaisa are known to us (i.e. we have dedicated extraction rules to store them with a Dynamic number) then you can add them to the Body in the Engagement Builder as:
{{ meas_custom_dynamic.enterValueHere }}
meas_dynamic stands for the Dynamic value associated with the measure (a measure being a Kaisa Dynamic Number). If a parameter sent to us is adTransmission for example, we will store it as dynamic_adTransmission if there is a dedicated rule for it in advance, and can be added to the Engagement Builder as:
{{ meas_custom_dynamic.adTransmission }}
Of course, any issues or any questions at all you can contact our Support team!
Comments
0 comments
Please sign in to leave a comment.