Oracle FusionサービスでのチャットのREST API

メッセージを投稿

post

/engagement/api/consumer/{fqSiteName}/v1/postMessage

この操作は、エンド・ユーザーがエージェントにメッセージを送信するために使用します。これらのメッセージのコレクションは、チャット・エンゲージメントで構成されます。
ユーザーは、チャット・エンゲージメントが作成されるとすぐにメッセージの送信を開始でき、チャット・エンゲージメントがエージェントによって受け入れられるまで待機する必要はありません。

リクエスト

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

application/json; charset=utf-8

パス・パラメータ

fqSiteName: string

セッションを確立するためにコールによって返されるサイトの名前。

問合せパラメータ

pool: string

セッションの確立レスポンスで指定されている、またはRNEngagementConfigurationChangedMessageシステム・メッセージで指定されているプールID。

ヘッダー・パラメータ

SessionId: string

コンシューマ・セッションの一意の識別子。

リクエスト情報を含むオブジェクト。

ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.requests.v1.PostEngagementMessageRequest

タイプ: object

ソースを表示

body: string

エンド・ユーザーからエージェントへのテキスト・メッセージ。
clientRequestTime(optional): string

yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
clientTransactionId(optional): integer(int64)

クライアント・トランザクションの一意の識別子。このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。リクエストをレスポンスにリンクするために使用されます。
messageDataMap(optional): object messageDataMap

このメッセージに関連付けられたクライアント提供のキー/バリュー文字列ペアのオプション・マップ。
messageId(optional): string

メッセージの一意の識別子。
offTheRecord(optional): boolean

テキスト・メッセージをレコードからとみなしてログに記録しないかどうかを示します。 trueの場合、メッセージはログに記録されません。デフォルト値はfalseです。
richText(optional): boolean

テキスト・メッセージがリッチ・テキストかどうかを示します。 trueの場合、メッセージはリッチ・テキストです。デフォルト値はfalseです。

{
    "required":[
        "body"
    ],
    "properties":{
        "body":{
            "type":"string",
            "description":"The text message from the end user to the agent."
        },
        "offTheRecord":{
            "type":"boolean",
            "description":"Indicates whether the text message should be considered &#39;off the record&#39; and not logged. If true, then the message is not logged. The default value is false."
        },
        "messageId":{
            "type":"string",
            "description":"The unique identifier of the message."
        },
        "richText":{
            "type":"boolean",
            "description":"Indicates whether the text message is rich text. If true, then the message is rich text. The default value is false."
        },
        "messageDataMap":{
            "type":"object",
            "description":"An optional map of client supplied key/value String pairs associated with this message."
        },
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        }
    }
}

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

タイプ: object

このメッセージに関連付けられたクライアント提供のキー/バリュー文字列ペアのオプション・マップ。

トップに戻る

レスポンス

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

application/json; charset=utf-8

200 レスポンス

リクエストは正常に完了しました。

ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.responses.v1.PostEngagementMessageResponse

タイプ: object

ソースを表示

clientId(optional): integer(int64)

クライアントの一意の識別子。
clientIdString(optional): string

文字列としてのクライアントの一意の識別子。
clientRequestTime(optional): string

yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
clientTransactionId(optional): integer(int64)

クライアント・トランザクションの一意の識別子。このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。リクエストをレスポンスにリンクするために使用されます。
clientTransactionIdString(optional): string

文字列としてのクライアント・トランザクションの一意の識別子。
serviceFinishTime(optional): string

リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で完了した時間。
serviceStartTime(optional): string

リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で開始した時間。

{
    "properties":{
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        },
        "clientTransactionIdString":{
            "type":"string",
            "description":"The unique identifier of the client transaction as a String."
        },
        "serviceStartTime":{
            "type":"string",
            "description":"The time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"string",
            "description":"The time when the request processing completed in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client."
        },
        "clientIdString":{
            "type":"string",
            "description":"The unique identifier of the client as a String."
        }
    }
}

400 レスポンス

リクエスト・オブジェクトの検証に失敗しました。

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

タイプ: object

403 レスポンス

コンシューマ・セッション識別子が不明です。

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

タイプ: object

404 レスポンス

リソースが見つかりませんでした。

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

タイプ: object

409 レスポンス

リード・エージェント参加者がエンゲージメントを終了しました。

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

タイプ: object

500 レスポンス

リクエストの処理中にチャット・サーバーでエラーが発生しました。

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

タイプ: object

トップに戻る

例

次の例は、cURLを使用してPOSTリクエストを発行してエージェントにメッセージを送信する方法を示しています:

cURLコマンドの例

curl -X POST "https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/postMessage?pool=353:2" -H "Accept: application/json;charset=utf-8" -H "Content-Type: application/json" -H "SessionId: 170c233dfi4gy1vkwyw6yxdq1a" -d "{\"clientRequestTime\" : \"2019-01-14T14:35:14.226Z\",\"clientTransactionId\" : 1,\"body\" : \"This is a test message.\",\"offTheRecord\" : false}"

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
   "clientRequestTime" : "2019-01-14T14:35:14.226Z",
   "clientTransactionId" : 1,
   "body" : "This is a test message.",
   "offTheRecord" : false
}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: 200 OK
Content-Type: application/json;charset=utf-8

応答本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "clientRequestTime": "2019-01-14T14:35:14.226Z",
    "serviceStartTime": "2019-01-11T10:12:41.806Z",
    "serviceFinishTime": "2019-01-11T10:12:41.819Z",
    "clientId": 246,
    "clientIdString": "246",
    "clientTransactionId": 1,
    "clientTransactionIdString": "1"
}

「トップに戻る」