MessagingChannel | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

MessagingChannel コンポーネントにはサフィックス messagingChannel が付けられ、messagingChannels フォルダーに保存されます。

バージョン

MessagingChannel コンポーネントは、API バージョン 55.0 以降で使用できます。

特別なアクセスルール

この種別は、メッセージングに関する権限である「メッセージングの設定」および「設定・定義を参照する」が組織で有効になっている場合に使用できます。

項目

項目名	説明
automatedResponses	項目の型 MessagingAutoResponse[] 説明メッセージングチャネルに関連付けられている自動レスポンス。
customParameters	項目の型 MessagingChannelCustomParameter[] 説明メッセージングチャネルに関連付けられているカスタムパラメーター。
description	項目の型 string 説明チャネルの説明。
masterLabel	項目の型 string 説明必須。チャネルの表示ラベル。
messagingChannelType	項目の型 MessagingChannelType (string 型の列挙) 説明必須。値は次のとおりです。 `EmbeddedMessaging` `Voice` — API バージョン 58.0 以降で利用できます。 Salesforce のサードパーティメッセージングチャネル (WhatsApp や Facebook Messenger など) では、このメタデータ型は使用されません。
sessionHandlerFlow	項目の型 string 説明チャネルのメッセージングセッションを転送するために使用されるオムニチャネルフロー。
sessionHandlerQueue	項目の型 string 説明必須。メッセージの転送に使用されるキュー。sessionHandlerFlow も選択されている場合、sessionHandlerQueue は、選択したフローでメッセージを転送できないときに使用される代替キューになります。
sessionHandlerType	項目の型 MessagingSessionHandlerType (string 型の列挙) 説明必須。チャネルでメッセージを転送するために使用されるメソッド。値は次のとおりです。 `Flow` `Queue`
standardParameters	項目の型 MessagingChannelStandardParameter[] 説明メッセージングチャンネルに追加されたパラメーター。

MessagingAutoResponse

チャネルで使用される自動レスポンスを表します。

項目名	説明
response	項目の型 string 説明必須。応答のテキスト。
type	項目の型 MessagingAutoResponseType (string 型の列挙) 説明必須。応答の種別。メッセージングセッションで使用するときに影響があります。値は次のとおりです。 `AgentEndEngagementResponse` `AgentEngagedResponse` `InitialResponse`

MessagingChannelCustomParameter

チャネルに追加されるカスタムパラメーターを表します。

項目名	説明
actionParameterMappings	項目の型 MessagingChannelActionParameterMapping[] 説明パラメーター値をフローまたはタスクに対応付けるために使用される対応付け。
externalParameterName	項目の型 string 説明必須。パラメーターの外部名。
masterLabel	項目の型 string 説明必須。パラメーターの表示ラベル。
maxLength	項目の型 int 説明パラメーター値の最大長。
name	項目の型 string 説明必須。パラメーターの名前。
parameterDataType	項目の型 FlowDataType (string 型の列挙) 説明必須。パラメーターの形式。値は次のとおりです。 `Apex` `Boolean` `Currency` `Date` `DateTime` `Multipicklist` `Number` `Picklist` `SObject` `String`

MessagingChannelActionParameterMapping

パラメーターとオムニチャネルフローまたはエージェント ToDo 間の対応付けを表します。

項目名	説明
actionParameterName	項目の型 string 説明必須。カスタムまたは標準パラメーターを対応付けるフローの名前。

MessagingChannelStandardParameter

情報をチャネルに渡すために使用される標準パラメーターを表します。

項目名	説明
actionParameterMappings	項目の型 MessagingChannelActionParameterMapping[] 説明パラメーターに関連付けられた対応付け。
parameterType	項目の型 MessagingChannelStandardParameterType (string 型の列挙) 説明必須。パラメーターの種別。値は次のとおりです。 `Email` `FirstName` `LastName` `Subject`

宣言的なメタデータの定義のサンプル

MessagingChannel コンポーネントの例を次に示します。このメッセージングチャ��ルは、カスタムおよび標準パラメーターをメッセージングチャネルからフローに渡し、代替キューを使用するフローに転送します。

1<?xml version="1.0" encoding="UTF-8"?>
2<MessagingChannel xmlns="http://soap.sforce.com/2006/04/metadata">
3    <automatedResponses>
4        <response>Hello there!</response>
5        <type>InitialResponse</type>
6    </automatedResponses>
7    <automatedResponses>
8        <response>Your agent is looking into the issue now.</response>
9        <type>AgentEngagedResponse</type>
10    </automatedResponses>
11    <automatedResponses>
12        <response>Bye!</response>
13        <type>AgentEndEngagementResponse</type>
14    </automatedResponses>
15    <customParameters>
16        <actionParameterMappings>
17            <actionParameterName>Flow_PhoneNumber</actionParameterName>
18        </actionParameterMappings>
19        <externalParameterName>PhoneNumber</externalParameterName>
20        <masterLabel>Phone Number</masterLabel>
21        <name>PhoneNumber</name>
22        <parameterDataType>Number</parameterDataType>
23    </customParameters>
24    <masterLabel>Initial Message</masterLabel>
25    <messagingChannelType>EmbeddedMessaging</messagingChannelType>
26    <sessionHandlerFlow>FlowName</sessionHandlerFlow>
27    <sessionHandlerQueue>FallbackQueueName</sessionHandlerQueue>
28    <sessionHandlerType>Flow</sessionHandlerType>
29    <standardParameters>
30        <actionParameterMappings>
31            <actionParameterName>Flow_LastName</actionParameterName>
32        </actionParameterMappings>
33        <parameterType>LastName</parameterType>
34    </standardParameters>
35    <standardParameters>
36        <actionParameterMappings>
37            <actionParameterName>Flow_FirstName</actionParameterName>
38        </actionParameterMappings>
39        <parameterType>FirstName</parameterType>
40    </standardParameters>
41    <standardParameters>
42        <actionParameterMappings>
43            <actionParameterName>Flow_Email</actionParameterName>
44        </actionParameterMappings>
45        <parameterType>Email</parameterType>
46    </standardParameters>
47    <standardParameters>
48        <actionParameterMappings>
49            <actionParameterName>Flow_Subject</actionParameterName>
50        </actionParameterMappings>
51        <parameterType>Subject</parameterType>
52    </standardParameters>
53</MessagingChannel>

メッセージングチャネルをキューに転送する場合、代替フローはありません。

1<?xml version="1.0" encoding="UTF-8"?>
2<MessagingChannel xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>EmbeddedChannel2</masterLabel>
4    <messagingChannelType>EmbeddedMessaging</messagingChannelType>
5    <sessionHandlerQueue>DemoQueueName</sessionHandlerQueue>
6    <sessionHandlerType>Queue</sessionHandlerType>
7</MessagingChannel>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>MessagingChannel</name>
6    </types>
7    <version>55.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。