{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ConvIntelligenceSignalRule - Data API",
  "description": "Represents a conversation intelligence signal rule. The rule triggers actions based on real-time intelligence signals from your telephony system or keywords mentioned by support reps or customers. The rule contains a set of conditions (subrules) and the filter logic used to evaluate those conditions to determine whether to trigger actions. This object is available in API version 62.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to"
  ],
  "fields": {
    "ActionType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Action to take based on the conversation intelligence signal detected during a conversation. Possible values are: Possible values are: AlertSupervisor–Sends an alert to the supervisor. AlertSupervisorAndAgent–Sends an alert to the rep and supervisor. LaunchFlow–Triggers an auto-launched flow. If set, also set ActionValue. LaunchNBA–Recommends the next best action to the rep.",
      "required": true
    },
    "ActionValue": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Action to perform based on the ActionType specified. If ActionType is set to LaunchFlow, this value is the DeveloperName of the flow to be launched. For example, EmailAlert. For all other ActionType values, don’t set this parameter."
    },
    "ConversationChannelId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "ID (ChannelAddressIdentifier) of the Messaging channel or name (InternalName) of the Voice channel. This field is a polymorphic relationship field.",
      "relationship_name": "ConversationChannel",
      "refers_to": "CallCenter, MessagingChannel",
      "required": true
    },
    "Criteria": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Filter logic applied to the rule conditions (subrules). For example, ((1 AND 2) OR 3). The numbers in the formula are derived from the ConvIntelligenceSignalSubrule.Order value plus 1. For example, filter logic (1 AND 2) is calculated by adding the first condition (Order=0) with the second condition (Order=1).",
      "required": true
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Required. Create, Filter, Group, Sort, Update",
      "description": "API name of the conversation intelligence signal rule."
    },
    "IsActive": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the conversation intelligence signal rule is active (true) or inactive (false). The default value is false.",
      "required": true
    },
    "Label": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Name of the conversation intelligence signal rule."
    },
    "ParticipantRole": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "If Service is set to KeywordMatch, this value determines whether the rule applies to utterances made by reps, customers, or both roles. Possible values are: Possible values are: Agent AgentOrCustomer Customer If Service is not set to KeywordMatch, don’t set this parameter."
    },
    "Service": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Salesforce- or partner-provided intelligence source. For Salesforce-provided intelligence sources, set this parameter to KeywordMatch. For partner-provided intelligence sources, possible values are: AmazonConnectContactLens If none of the options apply to you, contact your Salesforce representative for the service name.",
      "required": true
    }
  },
  "special_access_rules": "This type requires an add-on license for Salesforce Voice for Amazon Connect, Salesforce Voice for Partner Telephony with Amazon Connect, Salesforce Voice for Partner Telephony, or Digital Engagement.",
  "wsdl_segment": "```xml\n<complexType name=\"ConvIntelligenceSignalRule\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActionType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ActionValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ConversationChannelId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Criteria\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ParticipantRole\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Service\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "ActionType": {
      "field_label": "Action Type",
      "type": "picklist",
      "length": "255"
    },
    "ActionValue": {
      "field_label": "Action Value",
      "type": "string",
      "length": "255"
    },
    "ConversationChannelId": {
      "field_label": "Conversation Channel ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Criteria": {
      "field_label": "Criteria",
      "type": "string",
      "length": "255"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "Id": {
      "field_label": "Conversation Intelligence Signal Rule ID",
      "type": "id",
      "length": "18"
    },
    "IsActive": {
      "field_label": "Is Active",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Label": {
      "field_label": "Label",
      "type": "string",
      "length": "255"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "ParticipantRole": {
      "field_label": "Participant Role",
      "type": "picklist",
      "length": "255"
    },
    "Service": {
      "field_label": "Service",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}