Store

Definition

The Store verb allows the users to store additional data between the requests within the same call without having to pass it using either query string or some other workaround.

note

The total amount of data stored among all storage variables is limited to 128 KB. If this amount is exceeded, the next Store verbs used in FlexML instructions will be ignored.

tip

Refer to our Build Password-Protected FlexML Application quick start guide to learn more about how you can use the Store verb to protect your destination from unauthorized calls.

Supported Attributes

These attributes can be used to modify the Store verb. They are inserted as name-value pairs in the start-tag.

Attribute	Data Type	Description
name	string	The name of the data used to identify it within the Callback Returned Data.

Example

In this example, the additional data identified by the key1 and key2 names will be added to the callback returned data. The data will be passed to the URL specified in the Redirect verb together with the other call data.

<Response>
  <Store name="key1">some_data</Store>
  <Store name="key2">some more data</Store>
  <Redirect>http://www.example.com/path/to/handler</Redirect>
</Response>

Callback Returned Data

Successful requests return a JSON response that looks like the following:

{
    "AccountSid":"",
    "ApiVersion":"2.0",
    "CallerName":"",
    "CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
    "CallStatus":"completed",
    "Direction":"inbound",
    "From":"15162065338",
    "OriginalFrom":"+15162065338",
    "OriginalTo":"15162065337",
    "RequestUrl":"https://sampleurl.com/example",
    "Storage_key1": "some_data",
    "Storage_key2": "some more data",
    "To":"15162065337"
}

The following is an additional parameter and value that will be included in action requests.

Attribute	Data Type	Description
Storage_{name}	string	The name of the data key used to store the data between the requests. It consists of the static Storage_ part and the {name} variable received as the name attribute of the Store verb.

info

For a list of the other parameters and values to expect in action requests, refer to the FlexML Call Flow section.

Nesting Rules

• You cannot nest other verbs or nouns within the Store verb.
• You cannot nest the Store verb within other FlexML verbs.