機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

チャット顧客対応の作成 - サポートされていません

post

/crmRestApi/resources/11.13.18.05/chatInteractions

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• transcript: array Transcripts
  タイトル: Transcripts

  トランスクリプト・リソースは、チャット・インタラクションのチャット・トランスクリプト・メッセージのリストを取得するために使用されます。 リソースには、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーがアクセスできます。 トランスクリプトにアクセスできるのは、チャットに参加したDCSユーザー、またはチャットに参加したDCSユーザーのマネージャのみです。

{
    "type":"object",
    "properties":{
        "transcript":{
            "title":"Transcripts",
            "type":"array",
            "description":"The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by  DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.\nThe transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.",
            "items":{
                "$ref":"#/components/schemas/chatInteractions-transcript-item-post-request"
            }
        }
    }
}

ネストされたスキーマ : 成績証明書

タイプ: array

タイトル: Transcripts

トランスクリプト・リソースは、チャット・インタラクションのチャット・トランスクリプト・メッセージのリストを取得するために使用されます。 リソースには、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーがアクセスできます。 トランスクリプトにアクセスできるのは、チャットに参加したDCSユーザー、またはチャットに参加したDCSユーザーのマネージャのみです。

ソースを表示

• Array of: object chatInteractions-transcript-item-post-request

{
    "title":"Transcripts",
    "type":"array",
    "description":"The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by  DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.\nThe transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.",
    "items":{
        "$ref":"#/components/schemas/chatInteractions-transcript-item-post-request"
    }
}

ネストされたスキーマ : chatInteractions-transcript-item-post-request

タイプ: object

ソースを表示

• SenderType: string
  最大長: 100

  メッセージ送信者のタイプ。

{
    "type":"object",
    "properties":{
        "SenderType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the message sender.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

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

本文( )

ルート・スキーマ : chatInteractions-item-response

タイプ: object

ソースを表示

• InteractionId: integer
  読取り専用: true

  顧客対応の一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectId: integer (int64)
  読取り専用: true

  オブジェクトの一意の識別子。
• transcript: array Transcripts
  タイトル: Transcripts

  トランスクリプト・リソースは、チャット・インタラクションのチャット・トランスクリプト・メッセージのリストを取得するために使用されます。 リソースには、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーがアクセスできます。 トランスクリプトにアクセスできるのは、チャットに参加したDCSユーザー、またはチャットに参加したDCSユーザーのマネージャのみです。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InteractionId":{
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transcript":{
            "title":"Transcripts",
            "type":"array",
            "description":"The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by  DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.\nThe transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.",
            "items":{
                "$ref":"#/components/schemas/chatInteractions-transcript-item-response"
            }
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 成績証明書

タイプ: array

タイトル: Transcripts

トランスクリプト・リソースは、チャット・インタラクションのチャット・トランスクリプト・メッセージのリストを取得するために使用されます。 リソースには、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーがアクセスできます。 トランスクリプトにアクセスできるのは、チャットに参加したDCSユーザー、またはチャットに参加したDCSユーザーのマネージャのみです。

ソースを表示

• Array of: object chatInteractions-transcript-item-response

{
    "title":"Transcripts",
    "type":"array",
    "description":"The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by  DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.\nThe transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.",
    "items":{
        "$ref":"#/components/schemas/chatInteractions-transcript-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : chatInteractions-transcript-item-response

タイプ: object

ソースを表示

• ChatId: integer
  読取り専用: true

  チャットの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MessageContent: string
  読取り専用: true

  メッセージの内容。
• MessageDate: string (date-time)
  読取り専用: true

  メッセージが作成された日付と時間。
• MessageId: integer
  読取り専用: true

  メッセージの一意の識別子。
• MessageTypeCd: string
  読取り専用: true

  最大長: 30

  メッセージのタイプ。
• PartyName: string
  読取り専用: true

  最大長: 900

  メッセージ送信者の名前。
• SenderId: integer (int64)
  読取り専用: true

  メッセージ送信者識別子。
• SenderType: string
  最大長: 100

  メッセージ送信者のタイプ。

{
    "type":"object",
    "properties":{
        "MessageContent":{
            "type":"string",
            "description":"The content of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDate":{
            "type":"string",
            "description":"The date and the time when the message is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the message sender.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "maxLength":900,
            "type":"string",
            "description":"The name of the message sender.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderId":{
            "type":"integer",
            "description":"The message sender identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChatId":{
            "type":"integer",
            "description":"The unique identifier of the chat.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"The unique identifier of the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

写本

操作: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript

パラメータ:

• InteractionId: $request.path.InteractionId

トランスクリプト・リソースは、チャット・インタラクションのチャット・トランスクリプト・メッセージのリストを取得するために使用されます。 リソースには、ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACTロールに割り当てられたDCS認証済ユーザーがアクセスできます。 トランスクリプトにアクセスできるのは、チャットに参加したDCSユーザー、またはチャットに参加したDCSユーザーのマネージャのみです。

「トップに戻る」