機械翻訳について

アウトバウンド・メッセージの作成

post

/crmRestApi/resources/11.13.18.05/outboundMessages

リクエスト

ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Alternate Message ID
    最大長: 2000
    Eメール配信アプリケーションのアウトバウンドEメールの一意の識別子。
  • タイトル: Body
    アウトバウンド・メッセージの本文。
  • タイトル: Business Organization ID
    ビジネス・ユニット組織IDの一意の識別子。
  • タイトル: Channel ID
    アウトバウンド・メッセージのチャネルの一意の識別子。
  • タイトル: Channel Type Code
    最大長: 30
    チャネル・タイプ・コード。
  • タイトル: Corporate Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    アウトバウンド・メッセージに関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Delivery Type Code
    最大長: 30
    デフォルト値: ORA_SVC_IMMEDIATE
    アウトバウンド・メッセージの配信タイプ・コード。
  • タイトル: Message Content
    電子メールの内容など、アウトバウンド・メッセージのコンテンツ。
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージの一意の識別子。
  • タイトル: Outbound Message Number
    最大長: 30
    アウトバウンド・メッセージの代替キー識別子。
  • Outbound Message Parts
    タイトル: Outbound Message Parts
    アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
  • タイトル: Posted by Party ID
    アウトバウンド・メッセージを投稿したユーザーの一意のパーティ識別子。
  • タイトル: Processing Status Code
    最大長: 30
    アウトバウンド・メッセージの処理ステータス・コード。
  • タイトル: Reply to Address
    最大長: 240
    アウトバウンド・メッセージの返信先アドレス。
  • タイトル: Retry Count
    デフォルト値: 0
    アウトバウンド・メッセージの再試行回数。
  • タイトル: Sender Email Source Code
    最大長: 30
    アウトバウンド・メッセージの送信者Eメールのソース・コード。
  • タイトル: Sender Name
    最大長: 100
    アウトバウンド・メッセージを送信した送信者の名前。
  • タイトル: Sent Date
    送信者がメッセージを送信した日付。
  • タイトル: Source Code
    最大長: 30
    アウトバウンド・メッセージのソース・コード。
  • タイトル: Source Message Object ID
    アウトバウンド・メッセージのオブジェクト識別子。
  • タイトル: Source Message Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・メッセージ・オブジェクト・タイプ・コード。
  • タイトル: Source Object ID
    アウトバウンド・メッセージのソース・オブジェクト識別子。
  • タイトル: Source Object Primary Key Name
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト主キー。
  • タイトル: Source Object Template Name
    最大長: 240
    アウトバウンド・メッセージのテンプレート名。
  • タイトル: Source Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト・タイプ・コード。
  • タイトル: Status Code
    最大長: 30
    アウトバウンド・メッセージのステータス・コード。
  • タイトル: Status Details
    最大長: 1000
    アウトバウンド・メッセージのステータス詳細。
  • タイトル: Stripe Code
    最大長: 30
    アウトバウンド・メッセージのストライプ・コード。
  • タイトル: Subject
    最大長: 400
    アウトバウンド・メッセージの件名。
  • タイトル: Can Update Message
    アウトバウンド・メッセージが更新されたかどうかを示します。
  • タイトル: Use Posted by Party Email
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーのEメール。
  • タイトル: Use Posted by Party Name
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーの名前。
ネストされたスキーマ : アウトバウンド・メッセージ部品
タイプ: array
タイトル: Outbound Message Parts
アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Corporate Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    メッセージ・パートの通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージ詳細の一意の識別子。
  • タイトル: Outbound Message Part ID
    アウトバウンド・メッセージ詳細の一意の部分識別子。
  • タイトル: Part Name
    最大長: 64
    アウトバウンド・メッセージ詳細のパート名。
  • タイトル: Part Type Code
    最大長: 30
    アウトバウンド・メッセージ詳細のパート・タイプ。
  • タイトル: Part Value
    最大長: 2000
    アウトバウンド・メッセージ詳細のパート値。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : outboundMessages-item-response
タイプ: object
ソースを表示
  • タイトル: Alternate Message ID
    最大長: 2000
    Eメール配信アプリケーションのアウトバウンドEメールの一意の識別子。
  • タイトル: Body
    アウトバウンド・メッセージの本文。
  • タイトル: Business Organization ID
    ビジネス・ユニット組織IDの一意の識別子。
  • タイトル: Channel ID
    アウトバウンド・メッセージのチャネルの一意の識別子。
  • タイトル: Channel Type Code
    最大長: 30
    チャネル・タイプ・コード。
  • タイトル: Corporate Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    コードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    アウトバウンド・メッセージに関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    アウトバウンド・メッセージに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Can Delete Message
    読取り専用: true
    アウトバウンド・メッセージ・レコードを削除できるかどうかを示します。
  • タイトル: Delivery Type Code
    最大長: 30
    デフォルト値: ORA_SVC_IMMEDIATE
    アウトバウンド・メッセージの配信タイプ・コード。
  • タイトル: Last Updated Date
    読取り専用: true
    アウトバウンド・メッセージが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アウトバウンド・メッセージを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Message Content
    電子メールの内容など、アウトバウンド・メッセージのコンテンツ。
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージの一意の識別子。
  • タイトル: Outbound Message Number
    最大長: 30
    アウトバウンド・メッセージの代替キー識別子。
  • Outbound Message Parts
    タイトル: Outbound Message Parts
    アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
  • タイトル: Posted by Party ID
    アウトバウンド・メッセージを投稿したユーザーの一意のパーティ識別子。
  • タイトル: Processing Status Code
    最大長: 30
    アウトバウンド・メッセージの処理ステータス・コード。
  • タイトル: Reply to Address
    最大長: 240
    アウトバウンド・メッセージの返信先アドレス。
  • タイトル: Retry Count
    デフォルト値: 0
    アウトバウンド・メッセージの再試行回数。
  • タイトル: Sender Email Source Code
    最大長: 30
    アウトバウンド・メッセージの送信者Eメールのソース・コード。
  • タイトル: Sender Name
    最大長: 100
    アウトバウンド・メッセージを送信した送信者の名前。
  • タイトル: Sent Date
    送信者がメッセージを送信した日付。
  • タイトル: Source Code
    最大長: 30
    アウトバウンド・メッセージのソース・コード。
  • タイトル: Source Message Object ID
    アウトバウンド・メッセージのオブジェクト識別子。
  • タイトル: Source Message Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・メッセージ・オブジェクト・タイプ・コード。
  • タイトル: Source Object ID
    アウトバウンド・メッセージのソース・オブジェクト識別子。
  • タイトル: Source Object Primary Key Name
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト主キー。
  • タイトル: Source Object Template Name
    最大長: 240
    アウトバウンド・メッセージのテンプレート名。
  • タイトル: Source Object Type Code
    最大長: 30
    アウトバウンド・メッセージのソース・オブジェクト・タイプ・コード。
  • タイトル: Status Code
    最大長: 30
    アウトバウンド・メッセージのステータス・コード。
  • タイトル: Status Details
    最大長: 1000
    アウトバウンド・メッセージのステータス詳細。
  • タイトル: Stripe Code
    最大長: 30
    アウトバウンド・メッセージのストライプ・コード。
  • タイトル: Subject
    最大長: 400
    アウトバウンド・メッセージの件名。
  • タイトル: Can Update Message
    アウトバウンド・メッセージが更新されたかどうかを示します。
  • タイトル: Use Posted by Party Email
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーのEメール。
  • タイトル: Use Posted by Party Name
    最大長: 1
    デフォルト値: false
    アウトバウンド・メッセージを投稿したユーザーの名前。
ネストされたスキーマ : アウトバウンド・メッセージ部品
タイプ: array
タイトル: Outbound Message Parts
アウトバウンド・メッセージ・パート・リソースは、アウトバウンド・メッセージ・パートの表示、作成、更新および削除に使用されます。 ルート・アウトバウンド・メッセージ・リソース部分の説明を取得するために使用されます。
ソースを表示
ネストされたスキーマ : outboundMessages-OutboundMsgParts-item-response
タイプ: object
ソースを表示
  • タイトル: Corporate Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージ受信者を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アウトバウンド・メッセージが作成された日付。
  • タイトル: Type of Currency Conversion Rate
    最大長: 30
    メッセージ・パートの通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    メッセージ・パートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Can Delete Message Part
    読取り専用: true
    アウトバウンド・メッセージが削除されたかどうかを示します。
  • タイトル: Last Updated Date
    読取り専用: true
    アウトバウンド・メッセージ詳細が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アウトバウンド・メッセージ詳細を最後に更新したユーザーのログイン。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アウトバウンド・メッセージ詳細を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Outbound Message ID
    アウトバウンド・メッセージ詳細の一意の識別子。
  • タイトル: Outbound Message Part ID
    アウトバウンド・メッセージ詳細の一意の部分識別子。
  • タイトル: Part Name
    最大長: 64
    アウトバウンド・メッセージ詳細のパート名。
  • タイトル: Part Type Code
    最大長: 30
    アウトバウンド・メッセージ詳細のパート・タイプ。
  • タイトル: Part Value
    最大長: 2000
    アウトバウンド・メッセージ詳細のパート値。
  • タイトル: Can Update Message Part
    読取り専用: true
    アウトバウンド・メッセージを更新できるかどうかを示します。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによってアウトバウンド・メッセージを作成する方法を示しています。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
  "SourceObjId": 300100187585268,
  "SourceObjTypeCd": "ServiceRequest",	
  "Subject": "Outbound Test with default channel- Rakesh 1",
  "Body": "aHR0cHM6Ly93d3cuZ29vZ2xlLmNvLmluL21hcHMvZGlyL0RMRitDeWJlcitHcmVlbnMsK0RMRitDeWJlcitDaXR5LCtETEYrUGhhc2UrMiwrU2VjdG9yKzI0LCtHdXJ1Z3JhbSwrSGFyeWFuYS8vQDI4LjQ5MzY4NjgsNzcuMDIyODkxOSwxMnovZGF0YT0hNG04ITRtNyExbTUhMW0xITFzMHgzOTBkMTkzNzBhMGQ4NjIzOjB4YWE5NzI1MWUwNWM2Y2Q2YiEybTIhMWQ3Ny4wOTI5MzMhMmQyOC40OTM3MDQ3ITFtMA==",
  "SourceCd": "ORA_SVC_API",
  "StatusCd" : "ORA_SVC_COMMITTED",
  "ProcessingStatusCd" : "ORA_SVC_READY",
  "ReplyToAddress" : "fuscdrmsmc17_extservice@adcdat05.us.oracle.com",
  "StripeCd": "ORA_SVC_CRM",
  "RetryCount": 0,
  "SenderName": "Sales Admin",
  "OutboundMsgParts": [
    {
      "PartTypeCd": "ORA_SVC_TO",
      "PartName": "To",
      "PartValue": "rakesh.ambat@adcdat05.us.oracle.com"
    }
  ]
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "OutboundMessageId": 300100194002148,
  "SourceMsgObjId": null,
  "SourceObjId": 300100187585268,
  "SourceObjTypeCd": "ServiceRequest",
  "SourceObjTemplateName": null,
  "SourceObjPkName": null,
  "PostedByPartyid": null,
  "Subject": "Outbound Test with default channel- Rakesh 1",
  "SourceCd": "ORA_SVC_API",
  "ChannelId": null,
  "StatusCd": "ORA_SVC_COMMITTED",
  "StatusDetails": null,
  "ProcessingStatusCd": "ORA_SVC_READY",
  "SentDate": null,
  "ReplyToAddress": "fuscdrmsmc17_extservice@adcdat05.us.oracle.com",
  "BUOrgId": null,
  "StripeCd": "ORA_SVC_CRM",
  "CreationDate": "2020-08-05T11:35:32.051+00:00",
  "CreatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2020-08-05T11:35:32.051+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateLogin": "ABC957D47349945CE053773AF80A0B8D",
  "ChannelTypeCd": null,
  "RetryCount": 0,
  "SourceMsgObjTypeCd": null,
  "OutboundMessageNumber": "CDRM_0000049009",
  "SenderName": "Sales Admin",
  "UsePostedByEmailFlag": false,
  "UsePostedByNameFlag": false,
  "UpdateFlag": true,
  "DeleteFlag": true,
  "CorpCurrencyCode": null,
  "CurcyConvRateType": null,
  "CurrencyCode": null,
  "OutboundMsgParts": [
    {
      "OutboundMsgPartId": 300100194002149,
      "OutboundMessageId": 300100194002148,
      "PartTypeCd": "ORA_SVC_TO",
      "PartName": "To",
      "PartValue": "rakesh.ambat@adcdat05.us.oracle.com",
      "CreationDate": "2020-08-05T11:35:32.312+00:00",
      "CreatedBy": "SALES_ADMIN",
      "LastUpdateDate": "2020-08-05T11:35:32.312+00:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "LastUpdateLogin": "ABC957D47349945CE053773AF80A0B8D",
      "DeleteFlag": true,
      "UpdateFlag": true,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "CurrencyCode": null,
     ...
}

バッチ・ステータスのSRメッセージを作成する例

次の例は、JSON形式のバッチ・ステータスのSRメッセージを構成するリクエスト本文のコンテンツを示しています。

ノート:

SRメッセージを作成する前にSRを作成する必要があります

URL: https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/{{loc_srnumber}}/child/messagess

{
"MessageTypeCd": "ORA_SVC_RESPONSE",
"ChannelTypeCd": "ORA_SVC_EMAIL",
"RichTextFlag": true,
"SourceCd": "ORA_SVC_AGENT_UI",
"StatusCd": "ORA_SVC_COMMITTED",
"ProcessingStatusCd": "ORA_SVC_BATCH_READY",
"MessageContent": "{{ MessageContent }}",
"Subject": "{{ Subject }}",
"channelCommunication": [
{
"ChannelId": "ChannelId",
"PartyViaEndPoint": "john.doe@oracle.com",
"RoutingCd": "ORA_SVC_TO"
}
]
}

バッチ・ステータスのアウトバウンド・メッセージを作成する例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

URL: https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages

{
    "Subject": "{{ MessageTitle }}",
    "SourceCd": "ORA_SVC_API",
    "StatusCd": "ORA_SVC_COMMITTED",
    "ProcessingStatusCd": "ORA_SVC_READY",
    "StripeCd": "ORA_SVC_CRM",
    "ChannelTypeCd": "ORA_SVC_EMAIL",
    "SenderName": null,
    "UsePostedByEmailFlag": false,
    "UsePostedByNameFlag": false,
    "Body": "{{ MessageContent }}",
    "DeliveryTypeCd": "ORA_SVC_BATCH",
    "OutboundMsgParts": [
        {
            "PartTypeCd": "ORA_SVC_TO",
            "PartName": null,
            "PartValue": "john.doe@oracle.com"
        }
    ]
}
「トップに戻る」