On-demand Rule execution

(information)

Legal information

Conversation Intelligence, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For more details on AI usage and data, see AI Nutrition Facts for Conversation Intelligence.

Conversation Intelligence is not PCI compliant or a HIPAA Eligible Service and should not be used in workflows that are subject to HIPAA or PCI.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

POST/v3/RuleExecutions

Base url: https://intelligence.twilio.com (Twilio Intelligence API)

Resolves the given configuration, rule, and conversation, derives the memoryStoreId from the conversation's configuration. Then executes the rule on the conversation. Optionally, rule.operators[] can be provided to override specific operator parameters for this execution only; the stored rule configuration is not modified.

Request

Authentication

Basic Auth

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredPIIDescriptionChild properties

intelligenceConfigurationIdstring

required

The Intelligence Configuration identifier to execute the Rule within.

Example: intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5Pattern: ^intelligence_configuration_[0-7][0-9a-z]{25}$

ruleIdstring

required

The rule identifier to execute within the selected Intelligence Configuration.

Example: intelligence_configurationrule_01k6fc25s7epm9qtk8rszbv3q6Pattern: ^intelligence_configurationrule_[0-7][0-9a-z]{25}$

conversationIdstring

required

The Conversation identifier to execute the Rule against.

Example: conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2Pattern: ^conv_conversation_[0-7][0-9a-z]{25}$

ruleobject

Optional

Optional per-execution overrides applied to the stored rule before execution. When omitted, the stored rule executes unchanged. Only operators[].parameters is overridable; any other field is not part of this schema and is ignored.

Show rule properties

Responses

202400404422429500

Rule execution queued.

The request is malformed: the request body fails schema validation (a required field is missing, or a field does not match its expected pattern) or the request body is not valid JSON. For RuleExecutions creation with rule overrides: rule.operators is missing, an operator id in rule.operators does not exist in the stored rule, a parameter name is not defined by the operator, a parameter value provided for an operator override is invalid for that parameter, or a required parameter with no default is left blank.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Twilio-specific error code

messagestring

Optional

A human readable error message

httpStatusCodeinteger<int32>

Optional

HTTP response status code

userErrorboolean

Optional

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

For RuleExecutions creation: the intelligenceConfigurationId does not resolve to an existing Intelligence Configuration, the ruleId does not exist within that configuration, or the conversationId does not resolve to an existing conversation.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Twilio-specific error code

messagestring

Optional

A human readable error message

httpStatusCodeinteger<int32>

Optional

HTTP response status code

userErrorboolean

Optional

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

The request references valid resources, but the request cannot be processed as given. For RuleExecutions creation: the configuration and conversation resolved successfully, but no memoryStoreId could be derived from the conversation's configuration, so the rule execution cannot be built.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Twilio-specific error code

messagestring

Optional

A human readable error message

httpStatusCodeinteger<int32>

Optional

HTTP response status code

userErrorboolean

Optional

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

The Account has exceeded the allowed request rate for this endpoint. The X-RateLimit-Reset header indicates when the rate limit window resets.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Twilio-specific error code

messagestring

Optional

A human readable error message

httpStatusCodeinteger<int32>

Optional

HTTP response status code

userErrorboolean

Optional

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

An unexpected error prevented the request from being processed. For RuleExecutions creation, this includes failures resolving the configuration, rule, or conversation that are not classified as not-found errors.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

Twilio-specific error code

messagestring

Optional

A human readable error message

httpStatusCodeinteger<int32>

Optional

HTTP response status code

userErrorboolean

Optional

Whether the error is a user error (true) or a system error (false)

paramsobject

Optional

A map of parameters related to the error, for example, a params.twilioErrorCodeUrl might hold a URL or link to additional information

Show params properties

On-demand Rule execution

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createRuleExecution() {
11  const ruleExecution = await client.intelligence.v3.ruleExecutions.create({
12    intelligenceConfigurationId:
13      "intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5",
14    ruleId: "intelligence_configurationrule_01k6fc25s7epm9qtk8rszbv3q6",
15    conversationId: "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
16  });
17
18  console.log(ruleExecution);
19}
20
21createRuleExecution();