機械翻訳について

会話メッセージの取得

get

/crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : conversationMessages-item-response
タイプ: object
ソースを表示
  • タイトル: Assigned To
    会話メッセージが割り当てられるリソース・パーティの一意の識別子。 これは現在使用されておらず、将来のために予約されています。
  • タイトル: Assigned to Party Number
    読取り専用: true
    最大長: 30
    会話メッセージの割当先となるリソース・パーティの代替キー識別子。 これは現在使用されておらず、将来のために予約されています。
  • タイトル: Assigned to Party Name
    読取り専用: true
    最大長: 360
    会話メッセージに割り当てられているリソースの名前。 これは現在使用されておらず、将来のために予約されています。
  • Attachments
    タイトル: Attachments
    添付リソースは、添付の表示、作成および更新に使用されます。
  • タイトル: Channel ID
    会話メッセージに関連付けられたチャネルの一意の識別子。
  • タイトル: Channel Type Code
    最大長: 30
    会話メッセージに関連付けられているチャネルのタイプを示すコード。
  • タイトル: Channel Type Value
    読取り専用: true
    最大長: 255
    会話メッセージに関連付けられているチャネル・タイプの名前(Eメールやソーシャルなど)。
  • タイトル: Conversation Business Unit
    会話に関連付けられているビジネス・ユニット組織の一意の識別子。
  • タイトル: Conversation ID
    メッセージが関連付けられている会話の一意の識別子。
  • タイトル: Conversation Number
    最大長: 30
    メッセージが関連付けられている会話の代替キー識別子。
  • タイトル: Conversation Stripe Code
    最大長: 255
    CRM、HRHD、ISRなど、会話のアプリケーション・ストライプを示すコード。
  • タイトル: Conversation Type
    最大長: 255
    顧客やコラボレーションなど、会話のタイプを示すコード。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    会話メッセージを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    会話メッセージが作成された日付。
  • タイトル: Inbound Message Status Code
    最大長: 30
    インバウンドまたは内部コラボレーション・メッセージのステータス・コード。
  • タイトル: Status
    読取り専用: true
    最大長: 255
    インバウンドまたは内部コラボレーション・メッセージのステータスの表示値
  • タイトル: Last Updated Date
    読取り専用: true
    会話メッセージが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    会話メッセージを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    会話メッセージを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Message Alternate ID
    最大長: 100
    メッセージの代替識別子。
  • タイトル: Message Content
    Eメールのコンテンツなど、会話メッセージのコンテンツ。
  • タイトル: Message Count
    読取り専用: true
    最大長: 80
    会話に関連付けられたメッセージの合計数。
  • タイトル: Message ID
    読取り専用: true
    会話メッセージの一意の識別子。
  • タイトル: Message Number
    最大長: 30
    会話メッセージの代替キー識別子。
  • タイトル: Message Send Date
    アウトバウンド・メッセージを送信する日付。
  • タイトル: Message Status Code
    最大長: 30
    メッセージのステータス・コード(DRAFTやCOMMITTEDなど)。
  • タイトル: Message Template
    最大長: 320
    会話メッセージに関連付けられたテンプレートの名前。
  • タイトル: Message Template Object Type
    最大長: 30
    サービス・リクエスト、商談、営業リードなど、会話メッセージが作成されたオブジェクト・タイプ。
  • タイトル: Subject
    最大長: 1000
    会話メッセージのタイトル。
  • タイトル: Message Type Code
    最大長: 30
    会話メッセージのタイプを示すコード(INBOUNDやOUTBOUNDなど)。
  • タイトル: Message Type
    読取り専用: true
    最大長: 255
    会話メッセージ・タイプの値(インバウンド、アウトバウンド、内部ノート、システム・レスポンス、システム・ノートなど)。
  • タイトル: Message Template Object ID
    メッセージ・テンプレートに関連付けられたオブジェクトの一意の識別子。
  • タイトル: Original Application Reference
    最大長: 1000
    インポートされた会話メッセージの元のアプリケーション参照。
  • タイトル: Parent Message ID
    現在の会話メッセージの親メッセージの一意の識別子。 ユーザーがメッセージに返信すると、元のメッセージが返信の親メッセージになります。
  • タイトル: Parent Message Number
    最大長: 30
    親メッセージの代替キー識別子。
  • タイトル: Processing Application Code
    最大長: 30
    Oracle Marketing CloudやCX Salesなどのメッセージを処理するアプリケーションを示すコード。 通常、これはアウトバウンド・メッセージに使用されます。
  • タイトル: Processing Application Content Reference ID
    最大長: 30
    メッセージを処理するアプリケーション内のメッセージのコンテンツの参照ID。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。
  • タイトル: Processing Application Message ID
    最大長: 30
    処理アプリケーションのメッセージ識別子。 これは、CX Sales以外のアプリケーションがOracle Marketing Cloudなどのアウトバウンド・メッセージを処理する場合に使用されます。
  • タイトル: Processing Status Code
    最大長: 30
    会話メッセージの処理ステータス(WAITING、READY、ERROR、SUCCESSなど)を示すコード。
  • タイトル: Processing Status Detail
    最大長: 1000
    会話メッセージ処理ステータスの詳細。
  • タイトル: Queue ID
    会話メッセージが割り当てられるキューの一意の識別子。 これは現在使用されておらず、将来のために予約されています。
  • タイトル: Queue Name
    読取り専用: true
    最大長: 400
    会話メッセージが割り当てられるキューの名前。 これは現在使用されておらず、将来のために予約されています。
  • タイトル: Queue Number
    読取り専用: true
    最大長: 30
    会話メッセージが割り当てられるキューの代替キー識別子。 これは現在使用されておらず、将来のために予約されています。
  • Conversation Message Recipients
    タイトル: Conversation Message Recipients
    メッセージ受信者。
  • タイトル: Reported Date
    会話メッセージが報告された日付。 通常、メッセージをインポートしないかぎり、この日付は作成日と同じです。
  • タイトル: Sender Alternate ID
    メッセージ送信者の代替識別子。
  • タイトル: Sender Free Form Address
    最大長: 320
    メッセージの送信者の自由形式のアドレス。 たとえば、送信者の電子メール・アドレスです。
  • タイトル: Sender Party ID
    送信者パーティの一意の識別子。
  • タイトル: Sender
    読取り専用: true
    最大長: 360
    送信者パーティの名前。
  • タイトル: Sender Party Number
    読取り専用: true
    最大長: 30
    送信者の代替キー識別子。
  • タイトル: Sender Party Type Code
    最大長: 30
    ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ送信者のパーティ・タイプ・コード。
  • タイトル: Sent Date
    送信者がメッセージを送信した日付。 電子メールやソーシャルなどのチャネルを介してメッセージが自動的に作成される場合は、このフィールドに入力されません。
  • Smart Actions
    タイトル: Smart Actions
    このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
  • タイトル: Source Code
    最大長: 30
    ORA_SVC_AGENT_UI、API、ORA_SVC_INBOUND_MSGなど、会話メッセージのソースを示すコード。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : 会話メッセージ受信者
タイプ: array
タイトル: Conversation Message Recipients
メッセージ受信者。
ソースを表示
ネストされたスキーマ : スマートなアクション
タイプ: array
タイトル: Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
ソースを表示
ネストされたスキーマ : conversationMessages-attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : conversationMessages-recipients-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    会話メッセージ受信者を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    会話メッセージ受信者が作成された日付。
  • タイトル: Free Form Address
    最大長: 320
    会話メッセージ受信者の自由形式アドレス。 例:送信者の電子メール・アドレス。
  • タイトル: Last Updated Date
    読取り専用: true
    会話メッセージ受信者が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    会話メッセージ受信者を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    会話メッセージ受信者を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Message ID
    会話メッセージの一意の識別子。
  • タイトル: Message Number
    最大長: 30
    会話メッセージの代替キー識別子。
  • タイトル: Person ID
    受信者の一意の識別子。 受信者が従業員や非従業員などの内部個人の場合は、この値がロードされます。
  • タイトル: Recipient Alternate ID
    外部システム内の受信者の識別子など、受信者の代替識別子。
  • タイトル: Message Alternate ID
    最大長: 1000
    外部システム内のメッセージの代替識別子。
  • タイトル: Recipient ID
    読取り専用: true
    会話メッセージ受信者の一意の識別子。
  • タイトル: Recipient Number
    最大長: 30
    会話メッセージ受信者の公開一意識別子。
  • タイトル: Recipient Party ID
    会話メッセージ受信者のパーティの一意の識別子。
  • タイトル: Recipient Name
    読取り専用: true
    最大長: 360
    会話メッセージ受信者のパーティの名前。
  • タイトル: Recipient Party Number
    読取り専用: true
    最大長: 30
    会話メッセージ受信者のパーティの代替キー識別子。
  • タイトル: Recipient Party Type Code
    最大長: 30
    ORA_SVC_BUSINESS_CONTACT、ORA_SVC_RESOURCEなど、メッセージ受信者のパーティ・タイプ・コード。
  • タイトル: Recipient Type Code
    最大長: 30
    TO、CC、BCCなど、会話メッセージの受信者のタイプを示すコード。
ネストされたスキーマ : conversationMessages-smartActions-item-response
タイプ: object
ソースを表示
  • タイトル: Action Intent
    アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
  • タイトル: Active
    最大長: 1
    アクションがアクティブか非アクティブかを示すブール値。
  • タイトル: Application Roles
    最大長: 1000
    スマート処理に関連付けられたアプリケーション・ロール。
  • タイトル: Filter Condition
    最大長: 1000
    このアクションの修飾に使用するGroovyスクリプト。
  • タイトル: Confirmation Message
    最大長: 1024
    実行中のアクションの確認を求めるメッセージ。
  • タイトル: Content Type
    最大長: 50
    RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
  • タイトル: Contextual
    最大長: 1
    スマート処理がコンテキスト処理であるかどうかを示します。
  • タイトル: Data Security Privilege
    最大長: 250
    権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。
  • タイトル: Action Name
    最大長: 256
    わかりやすいアクション名。
  • タイトル: Parent Entity
    最大長: 150
    処理が属するRESTリソース。
  • タイトル: REST Endpoint
    最大長: 150
    アクションを実行するRESTエンドポイント。
  • タイトル: Included In
    最大長: 150
    このアクションが属するビュー・オブジェクト。 複数のカンマ区切り値を含めることができます。
  • タイトル: Included in Application
    最大長: 512
    このアクションを使用できるアプリケーションのリスト。
  • タイトル: Restricted
    最大長: 1
    この処理が内部かどうかを示すブール型。
  • Links
  • タイトル: Mass Action
    最大長: 1
    この処理を一括処理できるかどうかを示すブール・タイプです。
  • タイトル: HTTP Method
    最大長: 15
    HREFで使用するHTTPメソッド。
  • タイトル: Object Function
    最大長: 64
    スマート・アクションに関連付けられたオブジェクト関数。
  • タイトル: Page Type
    最大長: 256
    このアクションを使用できるページのリスト。
  • タイトル: Smart Suggest
    最大長: 1
    処理に対してスマート提案が使用可能かどうかを示します。
  • タイトル: System Action
    最大長: 1
    アクションがシード済かカスタムかを示すブール型。
  • タイトル: Attributes to Update
    最大長: 512
    処理UIの起動時に更新される属性。
  • タイトル: User Action ID
    処理を一意に識別します。 内部使用。
  • タイトル: Action Name
    最大長: 256
    名前でアクションを一意に識別します。 内部使用。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
  • タイトル: Priority
    処理の優先度を示す番号。
  • Smart Action REST Payload Definitions
    タイトル: Smart Action REST Payload Definitions
    リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    URL内の変数のメタデータをバインドします。
  • タイトル: User Security Privilege
    最大長: 2000
    ユーザー・セキュリティ権限。
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
ソースを表示
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ: array
タイトル: Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : conversationMessages-smartActions-UserActionNavigation-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    処理がシード済かカスタムかを示すブール値。
  • タイトル: Application Usage
    最大長: 50
    アプリケーションの使用状況。
  • タイトル: Navigation Metadata
    最大長: 1000
    特定の用途に必要なナビゲーションのMetadata。
  • タイトル: Primary Key
    ユーザー処理ナビゲーションの主キー。
  • タイトル: Navigation Type
    最大長: 100
    特定の用途に対して複数のナビゲーション・フローを持つようにプロビジョニングします。
ネストされたスキーマ : conversationMessages-smartActions-UserActionRequestPayload-item-response
タイプ: object
ソースを表示
  • タイトル: Payload Value Binding Type
    最大長: 64
    値のバインディング・タイプを示します。
  • Links
  • タイトル: Mandatory
    最大長: 1
    ペイロードが必須かどうかを示すブール値。
  • スマート・アクションのペイロードを一意に識別します。 内部使用。
  • タイトル: Request Payload Attribute Name
    最大長: 256
    ペイロードを形成するキー値ペアのキー。
  • タイトル: Smart Suggest Path
    最大長: 2048
    スマート候補に使用されるパス。
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    ブール値。
  • タイトル: Request Payload Attribute Value
    最大長: 250
    ペイロードを形成するキー値ペアの値。
  • タイトル: Payload Value Structure
    最大長: 20
    キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : conversationMessages-smartActions-UserActionURLBinding-item-response
タイプ: object
ソースを表示
  • タイトル: URL Binding Type
    最大長: 64
    これは、URLバインディング・ランタイムを処理するためのヒントです。
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    ブール・インジケータ。
  • スマート・アクションのURLバインドを一意に識別します。 内部使用。
  • タイトル: URL Binding Parameter Name
    最大長: 50
    ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。
  • タイトル: URL Binding Parameter Value
    最大長: 80
    ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
「トップに戻る」