会話メッセージの作成
post
/crmRestApi/resources/11.13.18.05/conversationMessages
リクエスト
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AssignedToPartyId: integer (int64)
タイトル:
Assigned To
会話メッセージが割り当てられるリソース・パーティの一意の識別子。 これは現在使用されておらず、将来のために予約されています。 -
attachments: array Attachments
タイトル:
Attachments
添付リソースは、添付の表示、作成および更新に使用されます。 -
ChannelId: integer (int64)
タイトル:
Channel ID
会話メッセージに関連付けられたチャネルの一意の識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type Code
最大長:30
会話メッセージに関連付けられているチャネルのタイプを示すコード。 -
ConversationBUOrgId: integer (int64)
タイトル:
Conversation Business Unit
会話に関連付けられているビジネス・ユニット組織の一意の識別子。 -
ConversationId(required): integer (int64)
タイトル:
Conversation ID
メッセージが関連付けられている会話の一意の識別子。 -
ConversationNumber: string
タイトル:
Conversation Number
最大長:30
メッセージが関連付けられている会話の代替キー識別子。 -
ConversationStripeCd: string
タイトル:
Conversation Stripe Code
最大長:255
CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。 -
ConversationTypeCd: string
タイトル:
Conversation Type
最大長:255
顧客やコラボレーションなど、会話のタイプを示すコード。 -
InboundStatusCd: string
タイトル:
Inbound Message Status Code
最大長:30
インバウンドまたは内部コラボレーション・メッセージのステータス・コード。 -
MessageAlternateId: string
タイトル:
Message Alternate ID
最大長:100
メッセージの代替識別子。 -
MessageContent(required): 文字列(バイト)
タイトル:
Message Content
Eメールのコンテンツなど、会話メッセージのコンテンツ。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
会話メッセージの代替キー識別子。 -
MessageSendDate: string (date-time)
タイトル:
Message Send Date
アウトバウンド・メッセージを送信する日付。 -
MessageStatusCd: string
タイトル:
Message Status Code
最大長:30
メッセージのステータス・コード(DRAFTやCOMMITTEDなど)。 -
MessageTemplate: string
タイトル:
Message Template
最大長:320
会話メッセージに関連付けられたテンプレートの名前。 -
MessageTemplateObjTypeCd: string
タイトル:
Message Template Object Type
最大長:30
サービス・リクエスト、商談、営業リードなど、会話メッセージが作成されたオブジェクト・タイプ。 -
MessageTitle: string
タイトル:
Subject
最大長:1000
会話メッセージのタイトル。 -
MessageTypeCd(required): string
タイトル:
Message Type Code
最大長:30
会話メッセージのタイプを示すコード(INBOUNDやOUTBOUNDなど)。 -
MsgTemplateObjectId: integer (int64)
タイトル:
Message Template Object ID
メッセージ・テンプレートに関連付けられたオブジェクトの一意の識別子。 -
OriginalSystemReference: string
タイトル:
Original Application Reference
最大長:1000
インポートされた会話メッセージの元のアプリケーション参照。 -
ParentMessageId: integer (int64)
タイトル:
Parent Message ID
現在の会話メッセージの親メッセージの一意の識別子。 ユーザーがメッセージに返信すると、元のメッセージが返信の親メッセージになります。 -
ParentMessageNumber: string
タイトル:
Parent Message Number
最大長:30
親メッセージの代替キー識別子。 -
ProcessingAPPCd: string
タイトル:
Processing Application Code
最大長:30
Oracle Marketing CloudやCX Salesなどのメッセージを処理するアプリケーションを示すコード。 通常、これはアウトバウンド・メッセージに使用されます。 -
ProcessingAPPContentReferenceId: string
タイトル:
Processing Application Content Reference ID
最大長:30
メッセージを処理するアプリケーション内のメッセージのコンテンツの参照ID。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。 -
ProcessingAPPMsgId: string
タイトル:
Processing Application Message ID
最大長:30
処理アプリケーションのメッセージ識別子。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。 -
ProcessingStatusCd: string
タイトル:
Processing Status Code
最大長:30
会話メッセージの処理ステータス(WAITING、READY、ERROR、SUCCESSなど)を示すコード。 -
ProcessingStatusDetail: string
タイトル:
Processing Status Detail
最大長:1000
会話メッセージ処理ステータスの詳細。 -
QueueId: integer (int64)
タイトル:
Queue ID
会話メッセージが割り当てられるキューの一意の識別子。 これは現在使用されておらず、将来のために予約されています。 -
recipients: array Conversation Message Recipients
タイトル:
Conversation Message Recipients
メッセージ受信者。 -
ReportedDate: string (date-time)
タイトル:
Reported Date
会話メッセージが報告された日付。 通常、メッセージをインポートしないかぎり、この日付は作成日と同じです。 -
SenderAlternateId: integer (int64)
タイトル:
Sender Alternate ID
メッセージ送信者の代替識別子。 -
SenderFreeFormAddress: string
タイトル:
Sender Free Form Address
最大長:320
メッセージの送信者の自由形式のアドレス。 たとえば、送信者の電子メール・アドレスです。 -
SenderPartyId: integer (int64)
タイトル:
Sender Party ID
送信者パーティの一意の識別子。 -
SenderPartyTypeCd: string
タイトル:
Sender Party Type Code
最大長:30
ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ送信者のパーティ・タイプ・コード。 -
SentDate: string (date-time)
タイトル:
Sent Date
送信者がメッセージを送信した日付。 電子メールやソーシャルなどのチャネルを介してメッセージが自動的に作成される場合は、このフィールドに入力されません。 -
smartActions: array Smart Actions
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。 -
SourceCd: string
タイトル:
Source Code
最大長:30
ORA_SVC_AGENT_UI、API、ORA_SVC_INBOUND_MSGなど、会話メッセージのソースを示すコード。
ネストされたスキーマ : スマートなアクション
タイプ:
array
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書ID。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
新しい添付ファイルに割り当てる名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
FreeFormAddress: string
タイトル:
Free Form Address
最大長:320
会話メッセージ受信者の自由形式アドレス。 例:送信者の電子メール・アドレス。 -
MessageId: integer (int64)
タイトル:
Message ID
会話メッセージの一意の識別子。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
会話メッセージの代替キー識別子。 -
PersonId: integer (int64)
タイトル:
Person ID
受信者の一意の識別子。 受信者が従業員や非従業員などの内部個人の場合は、この値がロードされます。 -
RecipientAlternateId: integer (int64)
タイトル:
Recipient Alternate ID
外部システム内の受信者の識別子など、受信者の代替識別子。 -
RecipientAlternateMessageId: string
タイトル:
Message Alternate ID
最大長:1000
外部システム内のメッセージの代替識別子。 -
RecipientNumber: string
タイトル:
Recipient Number
最大長:30
会話メッセージ受信者の公開一意識別子。 -
RecipientPartyId: integer (int64)
タイトル:
Recipient Party ID
会話メッセージ受信者のパーティの一意の識別子。 -
RecipientPartyTypeCd: string
タイトル:
Recipient Party Type Code
最大長:30
ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ受信者のパーティ・タイプ・コード。 -
RecipientTypeCd: string
タイトル:
Recipient Type Code
最大長:30
TO、CC、BCCなど、会話メッセージの受信者のタイプを示すコード。
ネストされたスキーマ : conversationMessages-smartActions-item-post-request
タイプ:
ソースを表示
object
-
ActionIntent: 文字列(バイト)
タイトル:
Action Intent
アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
アクションがアクティブか非アクティブかを示すブール値。 -
ApplicationRoles: string
タイトル:
Application Roles
最大長:1000
スマート処理に関連付けられたアプリケーション・ロール。 -
Condition: string
タイトル:
Filter Condition
最大長:1000
このアクションの修飾に使用するGroovyスクリプト。 -
ConfirmationMessage: string
タイトル:
Confirmation Message
最大長:1024
実行中のアクションの確認を求めるメッセージ。 -
ContentType: string
タイトル:
Content Type
最大長:50
RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。 -
ContextualFlag: boolean
タイトル:
Contextual
最大長:1
スマート処理がコンテキスト処理であるかどうかを示します。 -
DataPrivilege: string
タイトル:
Data Security Privilege
最大長:250
権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。 -
DisplayLabel(required): string
タイトル:
Action Name
最大長:256
わかりやすいアクション名。 -
Entity(required): string
タイトル:
Parent Entity
最大長:150
処理が属するRESTリソース。 -
Href: string
タイトル:
REST Endpoint
最大長:150
アクションを実行するRESTエンドポイント。 -
IncludedIn: string
タイトル:
Included In
最大長:150
このアクションが属するビュー・オブジェクト。 複数のカンマ区切り値を含めることができます。 -
IncludedInApplication: string
タイトル:
Included in Application
最大長:512
このアクションを使用できるアプリケーションのリスト。 -
InternalFlag: boolean
タイトル:
Restricted
最大長:1
この処理が内部かどうかを示すブール型。 -
MassActionFlag: boolean
タイトル:
Mass Action
最大長:1
この処理を一括処理できるかどうかを示すブール・タイプです。 -
Method: string
タイトル:
HTTP Method
最大長:15
HREFで使用するHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function
最大長:64
スマート・アクションに関連付けられたオブジェクト関数。 -
PageType: string
タイトル:
Page Type
最大長:256
このアクションを使用できるページのリスト。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest
最大長:1
処理に対してスマート提案が使用可能かどうかを示します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
アクションがシード済かカスタムかを示すブール型。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update
最大長:512
処理UIの起動時に更新される属性。 -
UserActionId: integer (int64)
タイトル:
User Action ID
処理を一意に識別します。 内部使用。 -
UserActionName(required): string
タイトル:
Action Name
最大長:256
名前でアクションを一意に識別します。 内部使用。 - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer (int64)
タイトル:
Priority
処理の優先度を示す番号。 -
UserActionRequestPayload: array Smart Action REST Payload Definitions
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。 -
UserActionURLBinding: array Smart Action User Interface Definitions
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。 -
UserPrivilege: string
タイトル:
User Security Privilege
最大長:2000
ユーザー・セキュリティ権限。
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ:
array
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ:
array
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : conversationMessages-smartActions-UserActionRequestPayload-item-post-request
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
Payload Value Binding Type
最大長:64
値のバインディング・タイプを示します。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
ペイロードが必須かどうかを示すブール値。 -
RequestPayloadId: integer (int64)
スマート・アクションのペイロードを一意に識別します。 内部使用。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name
最大長:256
ペイロードを形成するキー値ペアのキー。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path
最大長:2048
スマート候補に使用されるパス。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール値。 -
Value: string
タイトル:
Request Payload Attribute Value
最大長:250
ペイロードを形成するキー値ペアの値。 -
ValueStruct: string
タイトル:
Payload Value Structure
最大長:20
キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : conversationMessages-smartActions-UserActionURLBinding-item-post-request
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
URL Binding Type
最大長:64
これは、URLバインディング・ランタイムを処理するためのヒントです。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール・インジケータ。 -
URLBindingId: integer (int64)
スマート・アクションのURLバインドを一意に識別します。 内部使用。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name
最大長:50
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。 -
Value: string
タイトル:
URL Binding Parameter Value
最大長:80
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : conversationMessages-item-response
タイプ:
ソースを表示
object
-
AssignedToPartyId: integer (int64)
タイトル:
Assigned To
会話メッセージが割り当てられるリソース・パーティの一意の識別子。 これは現在使用されておらず、将来のために予約されています。 -
AssignedToPartyNumber: string
タイトル:
Assigned to Party Number
読取り専用:true
最大長:30
会話メッセージの割当先となるリソース・パーティの代替キー識別子。 これは現在使用されておらず、将来のために予約されています。 -
AssignedToPersonName: string
タイトル:
Assigned to Party Name
読取り専用:true
最大長:360
会話メッセージに割り当てられているリソースの名前。 これは現在使用されておらず、将来のために予約されています。 -
attachments: array Attachments
タイトル:
Attachments
添付リソースは、添付の表示、作成および更新に使用されます。 -
ChannelId: integer (int64)
タイトル:
Channel ID
会話メッセージに関連付けられたチャネルの一意の識別子。 -
ChannelTypeCd: string
タイトル:
Channel Type Code
最大長:30
会話メッセージに関連付けられているチャネルのタイプを示すコード。 -
ChannelTypeCdMeaning: string
タイトル:
Channel Type Value
読取り専用:true
最大長:255
会話メッセージに関連付けられているチャネル・タイプの名前(Eメールやソーシャルなど)。 -
ConversationBUOrgId: integer (int64)
タイトル:
Conversation Business Unit
会話に関連付けられているビジネス・ユニット組織の一意の識別子。 -
ConversationId: integer (int64)
タイトル:
Conversation ID
メッセージが関連付けられている会話の一意の識別子。 -
ConversationNumber: string
タイトル:
Conversation Number
最大長:30
メッセージが関連付けられている会話の代替キー識別子。 -
ConversationStripeCd: string
タイトル:
Conversation Stripe Code
最大長:255
CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。 -
ConversationTypeCd: string
タイトル:
Conversation Type
最大長:255
顧客やコラボレーションなど、会話のタイプを示すコード。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
会話メッセージを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
会話メッセージが作成された日付。 -
InboundStatusCd: string
タイトル:
Inbound Message Status Code
最大長:30
インバウンドまたは内部コラボレーション・メッセージのステータス・コード。 -
InboundStatusCdMeaning: string
タイトル:
Status
読取り専用:true
最大長:255
インバウンドまたは内部コラボレーション・メッセージのステータスの表示値 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
会話メッセージが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
会話メッセージを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
会話メッセージを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MessageAlternateId: string
タイトル:
Message Alternate ID
最大長:100
メッセージの代替識別子。 -
MessageContent: 文字列(バイト)
タイトル:
Message Content
Eメールのコンテンツなど、会話メッセージのコンテンツ。 -
MessageCount: string
タイトル:
Message Count
読取り専用:true
最大長:80
会話に関連付けられたメッセージの合計数。 -
MessageId: integer (int64)
タイトル:
Message ID
読取り専用:true
会話メッセージの一意の識別子。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
会話メッセージの代替キー識別子。 -
MessageSendDate: string (date-time)
タイトル:
Message Send Date
アウトバウンド・メッセージを送信する日付。 -
MessageStatusCd: string
タイトル:
Message Status Code
最大長:30
メッセージのステータス・コード(DRAFTやCOMMITTEDなど)。 -
MessageTemplate: string
タイトル:
Message Template
最大長:320
会話メッセージに関連付けられたテンプレートの名前。 -
MessageTemplateObjTypeCd: string
タイトル:
Message Template Object Type
最大長:30
サービス・リクエスト、商談、営業リードなど、会話メッセージが作成されたオブジェクト・タイプ。 -
MessageTitle: string
タイトル:
Subject
最大長:1000
会話メッセージのタイトル。 -
MessageTypeCd: string
タイトル:
Message Type Code
最大長:30
会話メッセージのタイプを示すコード(INBOUNDやOUTBOUNDなど)。 -
MessageTypeCdMeaning: string
タイトル:
Message Type
読取り専用:true
最大長:255
会話メッセージ・タイプの値(インバウンド、アウトバウンド、内部ノート、システム・レスポンス、システム・ノートなど)。 -
MsgTemplateObjectId: integer (int64)
タイトル:
Message Template Object ID
メッセージ・テンプレートに関連付けられたオブジェクトの一意の識別子。 -
OriginalSystemReference: string
タイトル:
Original Application Reference
最大長:1000
インポートされた会話メッセージの元のアプリケーション参照。 -
ParentMessageId: integer (int64)
タイトル:
Parent Message ID
現在の会話メッセージの親メッセージの一意の識別子。 ユーザーがメッセージに返信すると、元のメッセージが返信の親メッセージになります。 -
ParentMessageNumber: string
タイトル:
Parent Message Number
最大長:30
親メッセージの代替キー識別子。 -
ProcessingAPPCd: string
タイトル:
Processing Application Code
最大長:30
Oracle Marketing CloudやCX Salesなどのメッセージを処理するアプリケーションを示すコード。 通常、これはアウトバウンド・メッセージに使用されます。 -
ProcessingAPPContentReferenceId: string
タイトル:
Processing Application Content Reference ID
最大長:30
メッセージを処理するアプリケーション内のメッセージのコンテンツの参照ID。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。 -
ProcessingAPPMsgId: string
タイトル:
Processing Application Message ID
最大長:30
処理アプリケーションのメッセージ識別子。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。 -
ProcessingStatusCd: string
タイトル:
Processing Status Code
最大長:30
会話メッセージの処理ステータス(WAITING、READY、ERROR、SUCCESSなど)を示すコード。 -
ProcessingStatusDetail: string
タイトル:
Processing Status Detail
最大長:1000
会話メッセージ処理ステータスの詳細。 -
QueueId: integer (int64)
タイトル:
Queue ID
会話メッセージが割り当てられるキューの一意の識別子。 これは現在使用されておらず、将来のために予約されています。 -
QueueName: string
タイトル:
Queue Name
読取り専用:true
最大長:400
会話メッセージが割り当てられるキューの名前。 これは現在使用されておらず、将来のために予約されています。 -
QueueNumber: string
タイトル:
Queue Number
読取り専用:true
最大長:30
会話メッセージが割り当てられるキューの代替キー識別子。 これは現在使用されておらず、将来のために予約されています。 -
recipients: array Conversation Message Recipients
タイトル:
Conversation Message Recipients
メッセージ受信者。 -
ReportedDate: string (date-time)
タイトル:
Reported Date
会話メッセージが報告された日付。 通常、メッセージをインポートしないかぎり、この日付は作成日と同じです。 -
SenderAlternateId: integer (int64)
タイトル:
Sender Alternate ID
メッセージ送信者の代替識別子。 -
SenderFreeFormAddress: string
タイトル:
Sender Free Form Address
最大長:320
メッセージの送信者の自由形式のアドレス。 たとえば、送信者の電子メール・アドレスです。 -
SenderPartyId: integer (int64)
タイトル:
Sender Party ID
送信者パーティの一意の識別子。 -
SenderPartyName: string
タイトル:
Sender
読取り専用:true
最大長:360
送信者パーティの名前。 -
SenderPartyNumber: string
タイトル:
Sender Party Number
読取り専用:true
最大長:30
送信者の代替キー識別子。 -
SenderPartyTypeCd: string
タイトル:
Sender Party Type Code
最大長:30
ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ送信者のパーティ・タイプ・コード。 -
SentDate: string (date-time)
タイトル:
Sent Date
送信者がメッセージを送信した日付。 電子メールやソーシャルなどのチャネルを介してメッセージが自動的に作成される場合は、このフィールドに入力されません。 -
smartActions: array Smart Actions
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。 -
SourceCd: string
タイトル:
Source Code
最大長:30
ORA_SVC_AGENT_UI、API、ORA_SVC_INBOUND_MSGなど、会話メッセージのソースを示すコード。
ネストされたスキーマ : スマートなアクション
タイプ:
array
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
ソースを表示
ネストされたスキーマ : conversationMessages-attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
レコードを作成したユーザーの名前。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書ID。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
レコードを最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
新しい添付ファイルに割り当てる名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : conversationMessages-recipients-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
会話メッセージ受信者を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
会話メッセージ受信者が作成された日付。 -
FreeFormAddress: string
タイトル:
Free Form Address
最大長:320
会話メッセージ受信者の自由形式アドレス。 例:送信者の電子メール・アドレス。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
会話メッセージ受信者が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
会話メッセージ受信者を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
会話メッセージ受信者を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MessageId: integer (int64)
タイトル:
Message ID
会話メッセージの一意の識別子。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
会話メッセージの代替キー識別子。 -
PersonId: integer (int64)
タイトル:
Person ID
受信者の一意の識別子。 受信者が従業員や非従業員などの内部個人の場合は、この値がロードされます。 -
RecipientAlternateId: integer (int64)
タイトル:
Recipient Alternate ID
外部システム内の受信者の識別子など、受信者の代替識別子。 -
RecipientAlternateMessageId: string
タイトル:
Message Alternate ID
最大長:1000
外部システム内のメッセージの代替識別子。 -
RecipientId: integer (int64)
タイトル:
Recipient ID
読取り専用:true
会話メッセージ受信者の一意の識別子。 -
RecipientNumber: string
タイトル:
Recipient Number
最大長:30
会話メッセージ受信者の公開一意識別子。 -
RecipientPartyId: integer (int64)
タイトル:
Recipient Party ID
会話メッセージ受信者のパーティの一意の識別子。 -
RecipientPartyName: string
タイトル:
Recipient Name
読取り専用:true
最大長:360
会話メッセージ受信者のパーティの名前。 -
RecipientPartyNumber: string
タイトル:
Recipient Party Number
読取り専用:true
最大長:30
会話メッセージ受信者のパーティの代替キー識別子。 -
RecipientPartyTypeCd: string
タイトル:
Recipient Party Type Code
最大長:30
ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ受信者のパーティ・タイプ・コード。 -
RecipientTypeCd: string
タイトル:
Recipient Type Code
最大長:30
TO、CC、BCCなど、会話メッセージの受信者のタイプを示すコード。
ネストされたスキーマ : conversationMessages-smartActions-item-response
タイプ:
ソースを表示
object
-
ActionIntent: 文字列(バイト)
タイトル:
Action Intent
アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
アクションがアクティブか非アクティブかを示すブール値。 -
ApplicationRoles: string
タイトル:
Application Roles
最大長:1000
スマート処理に関連付けられたアプリケーション・ロール。 -
Condition: string
タイトル:
Filter Condition
最大長:1000
このアクションの修飾に使用するGroovyスクリプト。 -
ConfirmationMessage: string
タイトル:
Confirmation Message
最大長:1024
実行中のアクションの確認を求めるメッセージ。 -
ContentType: string
タイトル:
Content Type
最大長:50
RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。 -
ContextualFlag: boolean
タイトル:
Contextual
最大長:1
スマート処理がコンテキスト処理であるかどうかを示します。 -
DataPrivilege: string
タイトル:
Data Security Privilege
最大長:250
権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。 -
DisplayLabel: string
タイトル:
Action Name
最大長:256
わかりやすいアクション名。 -
Entity: string
タイトル:
Parent Entity
最大長:150
処理が属するRESTリソース。 -
Href: string
タイトル:
REST Endpoint
最大長:150
アクションを実行するRESTエンドポイント。 -
IncludedIn: string
タイトル:
Included In
最大長:150
このアクションが属するビュー・オブジェクト。 複数のカンマ区切り値を含めることができます。 -
IncludedInApplication: string
タイトル:
Included in Application
最大長:512
このアクションを使用できるアプリケーションのリスト。 -
InternalFlag: boolean
タイトル:
Restricted
最大長:1
この処理が内部かどうかを示すブール型。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MassActionFlag: boolean
タイトル:
Mass Action
最大長:1
この処理を一括処理できるかどうかを示すブール・タイプです。 -
Method: string
タイトル:
HTTP Method
最大長:15
HREFで使用するHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function
最大長:64
スマート・アクションに関連付けられたオブジェクト関数。 -
PageType: string
タイトル:
Page Type
最大長:256
このアクションを使用できるページのリスト。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest
最大長:1
処理に対してスマート提案が使用可能かどうかを示します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
アクションがシード済かカスタムかを示すブール型。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update
最大長:512
処理UIの起動時に更新される属性。 -
UserActionId: integer (int64)
タイトル:
User Action ID
処理を一意に識別します。 内部使用。 -
UserActionName: string
タイトル:
Action Name
最大長:256
名前でアクションを一意に識別します。 内部使用。 - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer (int64)
タイトル:
Priority
処理の優先度を示す番号。 -
UserActionRequestPayload: array Smart Action REST Payload Definitions
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。 -
UserActionURLBinding: array Smart Action User Interface Definitions
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。 -
UserPrivilege: string
タイトル:
User Security Privilege
最大長:2000
ユーザー・セキュリティ権限。
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ:
array
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ:
array
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : conversationMessages-smartActions-UserActionRequestPayload-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
Payload Value Binding Type
最大長:64
値のバインディング・タイプを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
ペイロードが必須かどうかを示すブール値。 -
RequestPayloadId: integer (int64)
スマート・アクションのペイロードを一意に識別します。 内部使用。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name
最大長:256
ペイロードを形成するキー値ペアのキー。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path
最大長:2048
スマート候補に使用されるパス。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール値。 -
Value: string
タイトル:
Request Payload Attribute Value
最大長:250
ペイロードを形成するキー値ペアの値。 -
ValueStruct: string
タイトル:
Payload Value Structure
最大長:20
キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : conversationMessages-smartActions-UserActionURLBinding-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
URL Binding Type
最大長:64
これは、URLバインディング・ランタイムを処理するためのヒントです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール・インジケータ。 -
URLBindingId: integer (int64)
スマート・アクションのURLバインドを一意に識別します。 内部使用。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name
最大長:50
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。 -
Value: string
タイトル:
URL Binding Parameter Value
最大長:80
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
リンク
- ChannelTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ChannelTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- InboundStatusCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_INBOUND_MSG_STAT_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: InboundStatusCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- MessageStatusCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_STATUS_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: MessageStatusCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- MessageTemplateObjTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_OBJECT_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: MessageTemplateObjTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- MessageTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_MESSAGE_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: MessageTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ProcessingAPPCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MSG_PROC_APP
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ProcessingAPPCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ProcessingStatusCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_PROCESS_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ProcessingStatusCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- SenderPartyTypeCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_SENDER_RECIPIENT_TYPE
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: SenderPartyTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- SourceCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: SourceCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- 添付
-
パラメータ:
- MessageNumber:
$request.path.MessageNumber
添付リソースは、添付の表示、作成および更新に使用されます。 - MessageNumber:
- 受信者
-
パラメータ:
- MessageNumber:
$request.path.MessageNumber
メッセージ受信者。 - MessageNumber:
- smartActions
-
パラメータ:
- MessageNumber:
$request.path.MessageNumber
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。 - MessageNumber:
例:
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、会話メッセージを作成する方法を示しています。
cURLコマンド
curl --location --request POST 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/conversationMessages' \
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "MessageTypeCd":"ORA_SVC_INBOUND", "MessageContent": "dGVzdCB1cGRhdGluZyBtZXNzYWdlIC0gY29udGVudA==" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "MessageId": 300100553446223, "MessageNumber": "CDRM_0000108048", "CreatedBy": "SALES_ADMIN", "CreationDate": "2021-11-03T06:47:30+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2021-11-03T06:47:30.291+00:00", "LastUpdateLogin": "CE9A3C587F7C4C74E0532048F70AE65D", "MessageTypeCd": "ORA_SVC_INBOUND", "MessageTitle": null, "SourceCd": null, "ChannelTypeCd": null, "ChannelTypeCdMeaning": null, "InboundStatusCd": "ORA_SVC_NEW", "InboundStatusCdMeaning": null, "MessageStatusCd": "ORA_SVC_COMMITTED", "ProcessingStatusCd": "ORA_SVC_SUCCESS", "ProcessingStatusDetail": null, "SentDate": "2021-11-03T06:47:30+00:00", "MessageSendDate": null, "OriginalSystemReference": null, "ConversationId": 300100553446227, "ConversationNumber": "CDRM_0000028036", "ConversationTypeCd": null, "ConversationStripeCd": null, "ConversationBUOrgId": null, "ParentMessageId": null, "ParentMessageNumber": null, "ChannelId": null, "QueueId": null, "QueueNumber": null, "QueueName": null, "AssignedToPartyId": null, "AssignedToPartyNumber": null, "AssignedToPersonName": null, "ProcessingAPPCd": "ENGAGEMENT_CENTER", "ProcessingAPPMsgId": null, "ProcessingAPPContentReferenceId": null, "MessageTemplateObjTypeCd": null, "MessageTemplate": null, "SenderPartyId": null, "SenderPartyNumber": null, "SenderPartyName": null, "SenderPartyTypeCd": null, "ReportedDate": "2021-11-03T06:47:30+00:00", "SenderFreeFormAddress": null, "MessageCount": null, "MsgTemplateObjectId": null, "SenderAlternateId": null, "MessageAlternateId": null, "MessageTypeCdMeaning": null, "links": [ ... }