Create message

shortcuts.xml

<?xmlversion="1.0"encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcutsxmlns:android="http://schemas.android.com/apk/res/android">
<capabilityandroid:name="actions.intent.CREATE_MESSAGE">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. text = "Message text content" -->
<parameter
android:name="message.text"
android:key="text"/>
<!-- Eg. disambiguatingDescription = "Video" -->
<parameter
android:name="message.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<!-- Eg. name = "John Doe" -->
<parameter
android:name="message.recipient.name"
android:key="name"/>
<!-- Eg. email = "johndoe@gmail.com" -->
<parameter
android:name="message.recipient.email"
android:key="email"/>
<!-- Eg. telephone = "012-345-6789" -->
<parameter
android:name="message.recipient.telephone"
android:key="telephone"/>
</intent>
</capability>
</shortcuts>

actions.xml

<?xmlversion="1.0"encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<actionintentName="actions.intent.CREATE_MESSAGE">
<fulfillmenturlTemplate="myapp://custom-deeplink{?text,disambiguatingDescription,name,email,telephone}">
<!-- e.g. text = "Message text content" -->
<!-- (Optional) Require a field eg.text for fulfillment with required="true" -->
<parameter-mappingurlParameter="text"intentParameter="message.text"required="true"/>
<!-- e.g. disambiguatingDescription = "Video" -->
<parameter-mappingurlParameter="disambiguatingDescription"intentParameter="message.disambiguatingDescription"/>
<!-- e.g. name = "John Doe" -->
<parameter-mappingurlParameter="name"intentParameter="message.recipient.name"/>
<!-- e.g. email = "johndoe@gmail.com" -->
<parameter-mappingurlParameter="email"intentParameter="message.recipient.email"/>
<!-- e.g. telephone = "012-345-6789" -->
<parameter-mappingurlParameter="telephone"intentParameter="message.recipient.telephone"/>
</fulfillment>
<!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
<fulfillmenturlTemplate="myapp://deeplink"/>
</action>
</actions>

shortcuts.xml

message.disambiguatingDescription is an intent parameter that supports inline inventory. By defining a <shortcut> for message.disambiguatingDescription, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the disambiguatingDescription_one shortcut, Assistant provides the associated shorcut identifier, ID_ONE, as the URL parameter disambiguatingDescription to fulfillment.

If there is no inventory match, the text value received in the query for message.disambiguatingDescription is passed as-is.

<?xmlversion="1.0"encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcutsxmlns:android="http://schemas.android.com/apk/res/android">
<capabilityandroid:name="actions.intent.CREATE_MESSAGE">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="message.text"
android:key="text"/>
<parameter
android:name="message.disambiguatingDescription"
android:key="disambiguatingDescription"/>
<parameter
android:name="message.recipient.name"
android:key="name"/>
<parameter
android:name="message.recipient.email"
android:key="email"/>
<parameter
android:name="message.recipient.telephone"
android:key="telephone"/>
</intent>
</capability>
<!-- Short and long labels must be @string resource. -->
<shortcut
android:shortcutId="ID_ONE"
android:shortcutShortLabel="@string/shortcut_short_label"
android:shortcutLongLabel="@string/shortcut_long_label">
<capability-bindingandroid:key="actions.intent.CREATE_MESSAGE">
<parameter-binding
android:value="disambiguatingDescription"
android:key="message.disambiguatingDescription"/>
</capability-binding>
</shortcut>
</shortcuts>

actions.xml

message.disambiguatingDescription is an intent parameter that supports inline inventory. By defining an <entity-set> for message.disambiguatingDescription, you can uniquely identify entities that are of interest to your app or restrict fulfillment to the set of supported entities.

In the following example, when the user query matches the disambiguatingDescription_one entity, Assistant provides the associated identifier, ID_ONE, as the URL parameter disambiguatingDescription to fulfillment.

If there is no inventory match, the text value received in the query for message.disambiguatingDescription is passed as-is.

<?xmlversion="1.0"encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<actionintentName="actions.intent.CREATE_MESSAGE">
<fulfillmenturlTemplate="myapp://deeplink{?disambiguatingDescription}">
<!-- disambiguatingDescription = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, disambiguatingDescription is a text value, such as "Video" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mappingurlParameter="disambiguatingDescription"intentParameter="message.disambiguatingDescription"/>
</fulfillment>
<!-- Define parameters with inventories here -->
<parametername="message.disambiguatingDescription">
<entity-set-referenceentitySetId="disambiguatingDescriptionEntitySet"/>
</parameter>
</action>
<entity-setentitySetId="disambiguatingDescriptionEntitySet">
<!-- Provide an identifier per entity -->
<entityidentifier="ID_ONE"name="disambiguatingDescription_one"alternateName="@array/disambiguatingDescription_one_synonyms"/>
<entityidentifier="ID_TWO"name="disambiguatingDescription_two"alternateName="@array/disambiguatingDescription_two_synonyms"/>
</entity-set>
</actions>

The url attribute associated with the entity can be used to determine the fulfillment URL if there is an inventory match. In the following example, when the user query matches the disambiguatingDescription_one entity, Assistant provides myapp://deeplink/one as the fulfillment URL.

<?xmlversion="1.0"encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<actionintentName="actions.intent.CREATE_MESSAGE">
<!-- Use url from inventory match for deep link fulfillment -->
<fulfillmenturlTemplate="{@url}"/>
<!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
<fulfillmenturlTemplate="myapp://deeplink"/>
<!-- Define parameters with inventories here -->
<parametername="message.disambiguatingDescription">
<entity-set-referenceentitySetId="disambiguatingDescriptionEntitySet"/>
</parameter>
</action>
<entity-setentitySetId="disambiguatingDescriptionEntitySet">
<!-- Provide a URL per entity -->
<entityurl="myapp://deeplink/one"name="disambiguatingDescription_one"alternateName="@array/disambiguatingDescription_one_synonyms"/>
<entityurl="myapp://deeplink/two"name="disambiguatingDescription_two"alternateName="@array/disambiguatingDescription_two_synonyms"/>
</entity-set>
</actions>