Virtual Agents

Overview

Virtual Agents (VA) introduce conversational artificial intelligence (AI) and Natural Language Processing (NLP) to CCAI Platform.

You can use the AI-powered virtual agents to act as the first line of customer support or configure them to handle support requests with limited to no human agent intervention.

You can use virtual agents to do the following:

• Configure multiple, distinct VAs that focus on specific issues and assign to a specific queue.

• Assign a virtual agent to answer incoming calls, chats, or leverage existing routing options at the queue level.

• Allow your human agents to receive escalations from a VA, or transfer a session to a VA.

End-user experience

End-users will experience seamless support, whether chatting with a virtual or human agent.

When VAs reach the limit of their knowledge, or when they experience a technical issue, interactions can be automatically escalated to a human agent and message can be displayed in the end-user UI.

The end-user is then placed in queue to be routed to an agent assigned to the queue.

Chat

Aside from the virtual agent's configurable name and avatar, there is no noticeable difference between agent types in the end-user UI.

Optionally, you can add a button ("Skip to Human Agent" button, headphones icon) to the UI, which enables end-users to skip the VA and be connected with a human agent. You can also configure user segments in your CRM to have specific groups of end-users (for example, VIPs) automatically bypass the VA.

Call

VA for aalls uses pre-programmed voice prompts and responses to interact with your end-users. You can build in flows so that the end-user can be escalated to a human agent, or alternatively prevent escalation from happening. You can use your own voice talent to supply audio recordings, or use a simulated voice based on supplied text.

Agent experience

The agent experience is only slightly changed. The human agent will see that the session was escalated from a VA in the CRM and in the Agent Adapter. For chat, the agent can see the conversation with the VA in the Chat Adapter.

Human and virtual agents can both transfer calls or chats to queues and to each other. Queues attended by VAs are labeled for the human agent's awareness.

Virtual agent: Create and link Google Dialogflow agents

You can use Dialogflow, a natural language recognition platform, to integrate a conversational profile for virtual agents.

Virtual agent Dialogflow platforms

Dialogflow ES (Legacy): This platform only supports agent setup for Chat channels. Select this option to onboard virtual agents built using Dialogflow ES.

Dialogflow CX - Chat, Voice: This option supports agent setup for both Chat and Voice channels. Virtual agent interactions are limited to basic functions such as conversational exchanges and dynamic data handling. DTMF for Voice is not supported. Select this option to onboard virtual agents built using Dialogflow CX.

As of Release 3.4, CCAI Platform automatically sets the channel-specific value when calling the Dialogflow CX API. Voice calls are set to voice, chat conversations are set to chat. This applies to Virtual Agent support for mobile chat, web chat and IVR. This functionality enables you to create channel- specific responses within your virtual agents. For more information about channel-specific responses, see the Dialogflow documentation.

Dialogflow CX - Voice: This option only supports virtual agent setup for Voice channels. Agent interactions include advanced functions such as DTMF support, consumer barge-in, CCAI Insights tracking, and many others. Select this option to onboard virtual agents built using Dialogflow CX.

Create Dialogflow ES and CX virtual agents

To onboard an agent into the CCAI Platform Portal, you must first create one in the Dialogflow Console.

1. Create a Dialogflow Account

2. Go to Trial in the side navigation bar.

3. Select agent type. For more information on the distinction between ES and CX agents see: Agent Types (ES, CX).

After you have selected your agent type, follow the steps in the Dialogflow quickstarts to create the agents in the Dialogflow Console. To create a Dialogflow agent see either Create a Dialogflow ES agent or Create a Dialogflow CX agent.

Create a service account key for your Dialogflow agent

You must enter a service key into the CCAI Platform Portal to link a Dialogflow virtual agent. The steps below walk you through the process of creating the service key in Google Cloud. For more information about Google service accounts see What are service accounts?.

If you have already created a service key with access to Dialogflow, you can skip this section.

after you have set up your agent, the agent will appear in your side navigation bar.

1. Navigate to https://console.cloud.google.com/. A default project will display.

2. In the toolbar drop-down, select the Google project that you used to set up your Dialogflow agent.

3. Select IAM & Admin.

4. In the side navigation select Service Accounts. The service account console will load.

5. Click +Create Service Account.

Enter the service account details in Google Cloud Service

1. Enter the service account details.

   1. Display name for this service account.

   2. Service account ID is required and must be unique.

   3. Describe what this service account will do.

   4. Grant this service account access to a project.

2. In the Select a role drop-down: Assign the Dialogflow API Admin role to the service account.

3. Click Continue.

4. (Optional) Grant additional users access to this service account.

Edit actions in the Service Accounts page

The Google Cloud Service Accounts page displays any service accounts associate with your project. This will be uploaded to the CCAI Platform Portal.

To create a service account key see Create a service account key.  Follow Google recommended best practices for storing your key.

Based on how your company handles segmentation within Dialogflow, you can create multiple virtual agent platform entries and add specific Dialogflow agents, or create one platform with many Dialogflow agents.

Repeat the above steps for each Dialogflow agent that you need to onboard to the CCAI Platform Portal.

Add a virtual agent Dialogflow platform

Dialogflow ES (Legacy): This platform only supports agent setup for Chat channels. Select this option to onboard agents built using Dialogflow ES.

Dialogflow CX - Chat, Voice: This option supports agent setup for both Chat and Voice channels. Agent interactions are limited to basic functions such as conversational exchanges and dynamic data handling. DTMF for Voice is not supported. Select this option to onboard agents built using Dialogflow CX.

Dialogflow CX - Voice: This option only supports agent setup for Voice channels. Agent interactions include advanced functions such as DTMF support, consumer barge-in, CCAI Insights tracking, and many others. Select this option to onboard Agents built using Dialogflow CX.

1. Go to Settings > Developer Settings > Virtual Agent.

2. Click + Add Platform.

   The Add a Virtual Agent platform dialog appears.

   

3. Enter a name for the new platform.

4. Select from the following services:

   Dialogflow ES (Legacy)

   Dialogflow CX - Chat, Voice

   Dialogflow CX - Voice

5. Click Create.

Re-onboard an existing Dialogflow agent and attach to a conversation profile

Re-onboard an exiting Dialogflow agent using the Dialogflow CX - Voice platform. You will need to attach the existing Dialogflow agent to an Agent Assist conversation profile.

1. Navigate to the Agent Assist Projects page. The Select Projects dialog is displayed.

2. Select the Google Cloud project from the list of displayed projects. The Agent Assist Console is displayed.

3. Change the region of the Agent Assist Console to match the region of your virtual agent, by updating the URL: projects/{project_name}/locations/{dialogflow_agent_region}/conversation-profiles

4. Click the Conversation Profiles tab on the left navigation pane. The Conversation Profiles page is displayed.

5. Click the Create new button. The New Conversation Profile page is displayed.

6. Enter the conversation profile name in the Display Name field.

7. To link the existing virtual agent to the conversation profile:

   • Navigate to Choose to use Dialogflow section.

   • Turn ON the Enable virtual agent toggle switch.

   • Enter the Dialogflow Agent ID in the Agents field.

8. Click the Create button to create and deploy the conversation profile.

Now, you can re-onboard this Dialogflow agent using the Dialogflow CX - Voice platform selection in the CCAI Platform Portal.

Virtual agent platform statuses

CCAI Platform validates keys based on JSON structure and key validity. A Dialogflow Agent is fully authenticated only when its key is in Valid status:

• Valid: All workflows in the platform are valid.

• NeedsAttention: One or more workflows in the platform are Invalid. Replace with valid keys to resolve.

• Invalid: All workflows in the platform are Invalid. When a platform status is invalid, the platform is automatically disabled. Replace invalid keys with valid keys to resolve.

If the status is Invalid or Needs Attention, replace the invalid keys by verifying the JSON file that you uploaded or generate a new JSON file from Dialogflow.

When the configuration steps are complete, your Virtual Agents are ready to work. For more information about how to manage them, see Virtual Agent: Managing, Assigning, and Reporting.

Virtual agents: Management and Reporting

Overview

The CCAI Platform virtual agent for Chat and Voice introduces conversational artificial intelligence (AI) and natural language processing (NLP) to CCAI Platform. The AI-powered virtual agents can act as the first line of customer support or be configured to handle support requests with limited to no human agent intervention.

Manage virtual agents

Virtual agents, like human agents, must be added to the CCAI Platform Portal and then assigned to queues. You can personify a virtual agent with a name and avatar.

Add and personify a virtual agent

If you have built agents in Dialogflow and connected them to a {product_name_short}} virtual agent platform, you can now complete the following steps to add and personify those agents in the CCAI Platform Portal:

1. Go to Settings > Virtual Agent.

2. Click Add Virtual Agent.

3. Enter a name.

4. Select a virtual agent Platform and Workflow from the dropdown. Workflows represent authenticated Dialogflow Agents.

5. (Chat only) Select the languages this virtual agent will use. Only languages that have been added in Settings > Languages and Messages will appear here.

6. To upload a custom avatar, mouse over the default image and click Update. A file selection screen appears and, once selected, you can use the built-in tool to crop the image:

   

7. Click Save.

8. At the top of the virtual agent page toggle virtual agents for Chat and/or Calls to On, depending on which channels you are using virtual agents for.

Assign virtual agents to queues

Each virtual agent can be assigned to one or more queues. They can be assigned to a queue with or without human agents assigned.

1. Go to Settings > Queue > Web (for chat VA) or IVR (for call VA).

2. Click on the queue you want to assign the virtual agent to:

   

3. On the queue settings page, click Assign Virtual Agent.

4. From the Virtual Agent dropdown select an agent. Only airtual agents in the On state are available.

5. Select this virtual agent's Hours of Operation:

   • 24 Hours: The virtual agent is available to take chats any time. If there are no human agents online, no escalations are possible.

   • Queue hours: The virtual agent is available only during the queue hours set in Settings > Support Center Details.

6. (Chat only) To give end-users the option of skipping the virtual agent, select Display Skip to human agent button. When this checkbox is marked, a headphones icon appears in the end-user UI. The end-user can click the icon any time during the chat session to be connected to a human agent.

7. (Chat only) If you have user segments configured in your CRM, you can Exclude users from virtual agent workflow. End-users who belong to the specified user segment are sent directly to a human agent. Toggle the feature to On, then select a segment field and value from the drop-down menu.

8. Click Save.

9. On the queue Settings page, mark the Virtual Agent Chat checkbox for Chat or Virtual Agent checkbox for Voice.

10. The virtual agent is now enabled for the queue.

Assign Voice virtual agent transfers to top-level queues

To enable this functionality, make sure that the top-level queue ID is entered as the destination in Dialogflow. You can find queue IDs in the Settings > Queue menu. Make sure that any required leaf queues are active.

In the IVR, the end-user will hear all the sub and leaf queue options below the top-level. If a top-level queue does not have any active sub or leaf queues or is configured incorrectly, the IVR Fallback mechanism will take action. It will either redirect the caller to the previous queue (if human agents are available), or it will convey an error message before disconnecting the call (if the escalating queue lacks human agents).

CRM integration configuration

The below setting only applies to the chat channel.

For sessions handled by Virtual Agents, the CRM behavior is set on the Operations Management page.

1. Go to Settings > Operation Management > Virtual Agent

2. Mark the checkbox, Create CRM cases for chats attended by Virtual Agents:

   • All attended chats: Each time an interaction is initiated by an end-user, a case is created in your CRM.

   • Minimum chats: Set the minimum chat message threshold, below which a CRM case is not created. This can reduce the number of unnecessary cases.

3. (Optional) Mark the checkbox, Close CRM cases when the chat session is resolved by a Virtual Agent.

4. To enable the gathering of a pre-configured metadata packet from your Web SDK when a chat is picked up by a virtual agent, mark the checkbox Collect configured custom data in chat session. The collected metadata is attached to the CRM ticket for that chat.

5. Click Save changes.

Virtual Agent dashboard for chats

A full dashboard for virtual agent-specific data can be found in Dashboard > Virtual Agent.

Chats: Queued, ongoing, completed

The Chat monitoring pages have an Answered By column that indicates whether a chat was initially answered by a virtual or human agent.

Set a default user for virtual agent

When a virtual agent creates a session or a record, an you can specify where the new sessions or records will go.

• Assign to a Default User: If enabled, sessions and records created by a virtual agent will be assigned to the default user.

• Leave unassigned: Sessions and records created by a virtual agent will not be assigned to any CRM user.

• Assign to a specific user: Sessions and records create by a virtual agent will go to a specified user. Enter the CRM user ID to specify the user.

Specify a default user

1. Go to Settings > Operations Management.
2. Locate Virtual Agent > Default User.
3. Select Assign to a specific user and enter the user ID.

For more information, see CRM Default User.

Custom payload handling

Custom Payload for Dialogflow allows you to enhance your Virtual Agent experience beyond plain text-based chat and voice support interactions. By using Custom Payloads in Dialogflow agents, you can configure your Virtual Agent to render Custom Responses and Custom Actions.

Custom Responses allows you to render the following messages types:

• Text

• Inline buttons

• Sticky buttons

• Images

• Videos

• Documents

• Complex views (combination one or more message types)

Custom Actions allow Virtual Agents to perform the following actions:

• Escalations to human agents

• Planned transfers to human agents

• End support session

CCAI Platform payload

To be used in Dialogflow as the custom payload. The following example demonstrates the format for responses in the webSDK using Dialogflow. Sticky buttons and inline buttons cannot be used together in the same payload.

{
  "ujet": {
    "type": "text|inline_button|sticky_button|image|video|document|complex|action",
    "action": "escalation|end",
    "title": "message displayed on the top of the message",   
    "escalation_reason": "by_consumer|by_virtual_agent",
    "session_variable": {
      "capture_target": "payload|end_user_response",
      "capture_key": "key",
      "payload": {
      }
    },
    "messages": [
      "Hello",
      "How can I help you?"
    ],
    "buttons": [
      {
        "title": "Button 1",
        "action": "quick_reply"
      },
      {
        "title": "Button 2",
        "action": "quick_reply"
      }
    ],
    "images": [
      {
        "url": "https://image.url",
        "text": "an alternate text for an image for when failed to load an image"
      },
      {
        "url": "https://image.url",
        "text": "an alternate text for an image"
      }
    ],
    "videos": [
      {
        "url": "https://video.url",
        "text": "an alternate text for a video for when failed to load a video"
      },
      {
        "url": "https://video.url",
        "text": "an alternate text for a video"
      }
    ],
    "documents": [
      {
        "url": "https://document.url",
        "text": "an alternate text for a document for when failed to load a document"
      },
      {
        "url": "https://document.url",
        "text": "an alternate text for a document"
      }
    ],
    "components": [
      {
        "type": "text",
        "messages": [
          "We need the information for helping you.",
          "Could you please choose the following options?"
        ]
      },
      {
        "type": "inline_button",
        "buttons": [
          {
            "title": "Button 1",
            "action": "quick_reply"
          },
          {
            "title": "Button 2",
            "action": "quick_reply"
          }
        ]
      },
      {
        "type": "image",
        "images": [
          {
            "url": "https://image.url",
            "text": "an alternate text for an image for when failed to load an image"
          },
          {
            "url": "https://image.url",
            "text": "an alternate text for an image"
          }
        ]
      }
    ]
  }
}

Chat Message Format For Custom Payload

Used with the CCAI Platform SDK to show a proper UI. It is the same with Dialogflow Custom Payload format but doesn't have "ujet" field in the root. See the below examples for the details.

Examples

{
  "ujet": {
    "type": "text",
    "messages": [
      "Hello",
      "How can I help you?"
    ]
  }
}

Escalation

{
  "ujet": {
    "type": "action",
    "action": "escalation",
    "escalation_reason": "by_virtual_agent"
  }
}

{
  "ujet": {
    "type": "action",
    "action": "escalation",
    "escalation_reason": "by_consumer"
  }
}

{
  "ujet": {
    "type": "action",
    "action": "escalation",
    "escalation_reason": "by_virtual_agent",
    "menu_id": 100,
    "language": "ko"
  }
}

{
  "ujet": {
    "type": "action",
    "action": "escalation",
    "escalation_reason": "by_consumer",
    "menu_id": 100,
    "language": "ko"
  }
}

End Conversation

{
  "ujet": {
    "type": "action",
    "action": "end"
  }
}

Inline Button

{
  "ujet": {
    "type": "inline_button",
    "title": "Select a menu",
    "buttons": [
      {
        "title": "Lorem Ipsum",
        "action": "quick_reply"
      },
      {
        "title": "Lorem Ipsum Dolor Sit Amet",
        "action": "escalation"
      }
    ]
  }
}

Example

Sticky Button

{
  "ujet": {
    "type": "sticky_button",
    "title": "Select a menu",
    "buttons": [
      {
        "title": "Lorem Ipsum",
        "action": "quick_reply"
      },
      {
        "title": "Lorem Ipsum Dolor Sit Amet",
        "action": "escalation"
      }
    ]
  }
}

Example

Image View

{
  "ujet": {
    "type": "image",
    "title": "Please see the following images",
    "images": [
      {
        "url": "https://image1.url",
        "text": "an alternate text for an image for when failed to load an image"
      },
      {
        "url": "https://image2.url",
        "text": "an alternate text for an image"
      }
    ]
  }
}

Video View

{
  "ujet": {
    "type": "video",
    "title": "Please see the following videos",
    "videos": [
      {
        "url": "https://video1.url",
        "text": "an alternate text for an video for when failed to load an video"
      },
      {
        "url": "https://video2.url",
        "text": "an alternate text for an video"
      }
    ]
  }
}

Document View

{
  "ujet": {
    "type": "document",
    "title": "Please see the following document",
    "documents": [
      {
        "url": "https://document1.url",
        "text": "an alternate text for an document for when failed to load an document"
      },
      {
        "url": "https://document2.url",
        "text": "an alternate text for an document"
      }
    ]
  }
}

Complex View

{
  "ujet": {
    "type": "complex",
    "title": "Welcome to CCAI Platform world!",
    "components": [
      {
        "type": "text",
        "messages": [
          "We need the information for helping you.",
          "Could you please choose the following options?"
        ]
      },
      {
        "type": "inline_button",
        "buttons": [
          {
            "title": "Button 1",
            "action": "quick_reply"
          },
          {
            "title": "Button 2",
            "action": "quick_reply"
          }
        ]
      },
      {
        "type": "image",
        "images": [
          {
            "url": "https://image1.url",
            "text": "an alternate text for an image for when failed to load an image"
          },
          {
            "url": "https://image2.url",
            "text": "an alternate text for an image"
          }
        ]
      }
    ]
  }
}

Configuring a custom payload in Dialogflow

For more information on how to configure your custom payload using Dialogflow, please refer to the Custom Payload Responses (Dialogflow ES) or Custom Payload (DialogflowCX) resources in the Google Cloud help center.

For more additional information, see Custom Session Variables for Custom Payload Handling.

VA transfer to phone or SIP endpoint

Voice VA has the ability to transfer a call to a specific phone number or SIP endpoint, ensuring that the consumer is connected to the appropriate person or department.

To enable call transfer to a phone number or SIP endpoint, use the following Dialogflow custom payloads. When the payload is received, the CCAIP system will transfer the call to the specified phone number or SIP endpoint.

If the connection is successful, the VA will be removed from the call session and the call session will continue. However, if the connection cannot be established, a transfer failure message will be played and the call will continue with the VA.

The transfer to phone or SIP is functional for both internal and external transfers. To track transfers to SIP/Phone numbers, they will be recorded as Planned Transfers in VA metrics.

To transfer a call to a phone number, you can use the following Dialogflow payload:

{
"ujet": {
"type": "action",
"action": "deflection",
"deflection_type" : "phone",
"phone_number": "+16509424879"
}
} 

To transfer a call to a SIP endpoint, you can use the following Dialogflow payload:

{
    "ujet": {
       "type": "action",
       "action": "deflection",
       "deflection_type" : "sip",
       "sip_uri": "sip:1-999-123-4567@voip-provider.example.net"
    }
}

Custom Session Variables for Custom Payload Handling

Use Custom Session variables to capture values from the Intent Response and the End User Response, then collect all of them and upload them to CRM as a comment.

Capture from End User Response

Flow

1. The CCAI Platform Server requests the response to Dialogflow.

   Dialogflow may callback it to the customer's server by Fulfillment.

   The customer's server is supposed to fill session_variable field in the response.

2. Dialogflow returns the response with the custom payload including session_variable field with capture_target = end_user_response

3. An end-user sends a message.

4. The CCAI Platform Server keeps the end-user message in step 3.

5. The CCAI Platform Server will post all session variables which have been captured in the chat session to CRM as a comment when a virtual agent left from a chat.

Custom Payload Format

{
  "ujet": {
    "session_variable": {
      "capture_target": "end_user_response",
      "capture_key": "key"
    }
  }
}

The next consumer message immediately after a virtual agent sends a custom payload will be captured as a session variable with the key "key".

Capture from Intent Response

Flow

1. The CCAI Platform Server requests the response to Dialogflow.

   1. Dialogflow may callback it to the customer's server by Fulfillment.

   2. The customer's server is supposed to fill session_variable field in the response.

2. Dialogflow returns the response with the custom payload including session_variable field with capture_target = "payload".

3. The CCAI Platform Server keeps payloadobject in step 2.

4. The CCAI Platform Server will post all session variables which have been captured in the chat session to CRM as a comment when a virtual agent left from a chat.

Custom Payload Format

{
  "ujet": {
    "session_variable": {
       "capture_target": "payload",
       "payload": {
         "status": "Cancelled",
         "order_id": "12345"
       }
     }
  }
}

Custom Session Variable Upload on CRM

For each session variable, the server is supposed to gather all session variables internally then upload them on CRM when a virtual agent leaves.

CRM Message Example

###########################

Chat ID: 1
Menu ID: 1
Chatbot Platform: Platform Name
Chatbot Workflow: Workflow Name
Virtual Agent: Virtual Agent Name

###########################

Intent: Intent Captured from End User Response
Captured At: 2020-06-25 14:54:19

Captured Variables
request: Cancel Order

###########################

Intent: Intent Captured from Payload
Captured At: 2020-06-25 14:58:23

Captured Variables
status: Cancelled
order_id: #12345

###########################

Example

Scenario

{
  "ujet": {
    "type": inline_button",
    "title": "How can I help you",
    "buttons": [
      {
        "title": "Cancel My Order",
        "action": "quick_reply",
        "reply_message": "cancel_order"
      }
    ]
  }
}

{
  "ujet": {
    "type": "text",
    "messages": [
      "Can you provide the order id?"
    ],
    "session_variable": {
       "capture_target": "end_user_response",
       "capture_key": "order_id"
    }
 }
}

order_id: Order id is #12345.

{
  "ujet": {
    "type": "text",
    "messages": [
      "Order #12345 is canceled."
      "Do you need anything else?"
    ],
    "session_variable": {
       "capture_target": "payload",
       "payload": {
         "order_id": "#12345",
         "order_status": "canceled"
   }
  }
 }
}

order_id: #12345
order_status: canceled

{
  "ujet": {
     "type": "escalation"
  }
}   

Custom Session Variable Upload on CRM

From the scenario above, the following comment posts on the CRM ticket:

---------------------------------

Chat ID: 1
Menu ID: 1
Chatbot Platform: Platform Name
Chatbot Workflow: Workflow Name
Virtual Agent: Virtual Agent Name

--------------------------------

Intent: Intent Captured from End User Response
Captured At: 2020-06-25 14:54:19

Captured Variables
order_id: Order id is #12345.

--------------------------------

Intent: Intent Captured from Payload
Captured At: 2020-06-25 14:58:23

Captured Variables
order_id: #12345
order_status: canceled

--------------------------------

Custom payload: VA transfer to phone or SIP endpoint

To enable call transfer to a phone number or SIP endpoint, use the following Dialogflow custom payloads. When the payload is received, the CCAI Platform system will transfer the call to the specified phone number or SIP endpoint.

If the connection is successful, the VA will be removed from the call session and the call session will continue. If the connection cannot be established, a transfer failure message will be displayed and the call will continue with the VA.

The transfer to phone or SIP is functional for both internal and external transfers. Transfers to SIP/phone numbers are recorded as Planned Transfers in VA metrics.

To transfer a call to a phone number, you can use the following Dialogflow payload:

{
"ujet": {
"type": "action",
"action": "deflection",
"deflection_type" : "phone",
"phone_number": "+16509424879"
}
}

To transfer a call to a SIP endpoint, you can use the following Dialogflow payload:

{
    "ujet": {
       "type": "action",
       "action": "deflection",
       "deflection_type" : "sip",
       "sip_uri": "sip:1-999-123-4567@voip-provider.example.net"
    }
}

Configure content cards

Content cards display concise and visually appealing content in a card-like format, making it easy for end-users to consume and interact with the presented information. You can create content cards using Dialogflow and customize them with titles, subtitles, and body text.

The following example uses content cards to display restaurant options to the end-user:

Content card properties

Dialogflow payload: Add validation and accept the content card type

A specific Dialogflow payload type handles content cards when messages from end-users are received through the chatbot server. The following is an example of a Dialogflow payload:

{
  "ujet": {
    "type": "content_card",
    "cards": [
      {
        "title": "Title",
        "subtitle": "Subtitle",
        "body": "Body",
        "link": "app://page",
        "event_params": {} # for deep-link click event
      }
    ]
  }
}

Information about content cards in CRM chat history

Card title information is logged to keep track of which cards the end-user has clicked on. This information is recorded in the CRM chat history.

In the following example, the chat message history in CRM displays the content card interaction.

[Chat message history]
ID: 305   |   2023-07-06     PDT
--------------------------------------------------
[01:13:32     VA]     Welcome message

...

[01:14:35     Mobile U.]     Content Cards:
- Title 1
- Title 2

Log content card title click events

To log when an end-user clicks on the title of a content card, use the following format to capture the event:

{end_user_name} clicked on the '{title}' card.
Note Title: Content Card click
Note Comment: 'John Doe' clicked on the 'See our new website' card.

Create a content card click event using the End User Event API

When an end-user clicks on the title of a content card, you can record this event by sending a POST request to the specified URL along with the title of the clicked card.

API endpoint: POST /api/v2/chat/:id/end_user_event

Usage: Create content card click event.

URL: /api/v2/chats/:id/end_user_event

Method: POST

Parameters:

Example request:

{
  "event": {
    "name": "content_card_clicked",
    "payload": {
      "title": "New our website" 
    }
  },
  "end_user_name": "consumer 1"   ## optional
}

Response: Status: 202 Accepted

Support for partial response in Dialogflow

Contact Center AI Platform supports the partial response feature in Dialogflow. This is particularly useful when your virtual agent needs to call a webhook that will likely take a while to run. With partial response enabled, Dialogflow can immediately send an initial fulfillment message to the end-user, such as, "One moment while I look that up." This way, while the webhook runs and the final fulfillment message is generated, the end-user expects a short wait instead of assuming that there is a problem. For more information, see Partial response for streaming API.