会話内容の取得

AIオペレータ と 通話相手先 との間で会話された、発話内容 (メッセージ) の情報を取得します。

リクエスト

GET <ベースURL>/v1/calls/{callId}/conversations
パス・パラメータ
callId

stringrequired

情報を取得する通話のコールID
リクエスト・ヘッダ
x-commubo-tenantId

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のテナントID。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
x-commubo-accessToken

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のアクセストークン。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
リクエスト・ボディ
リクエスト・ボディは必要ありません。
curl コマンドにおける例
会話内容の取得
curl -X GET \
  "https://connect.commubo.com:65536/v1/calls/1234567890123456/conversations" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321"

※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。

レスポンス

200 OK
リクエストが成功したことを示し、会話内容の情報をレスポンス・ボディで返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
発話内容 (メッセージ) のオブジェクトが配列形式で返ります。
発話内容が存在しない場合も、空のリストを含む 200 OK を返します。
{
    "seq": "1",
    "messageType": "0",
    "operator": {
        "operatorId": "11112222-3333-4444-5555-6666777788889999"
    },
    "nodeName": "hijklmn",
    "nodeType": "opqrstu",
    "checkPoint": "abcdefg",
    "startMsec": "123",
    "endMsec": "456",
    "text": "よろしくお願いします",
    "dictation": "よろしくおねがいします"
}
seq

integer

発話の順序を示すシーケンス番号 (1 から始まる番号)。
messageType

integer

発話者の種別を、次の値により示します。
0
AIオペレータの発話。
1
通話相手先 (人) の発話。
operator

object

発話したAIオペレータのオブジェクト。
messageType が 0 以外 (発話者が AIオペレータ以外) の場合には、このオブジェクトの内容は含まれません。
operatorId

string

AIオペレータのID。
個々のAIオペレータを識別するIDです。
nodeName

string

会話の位置を示す、会話シナリオ中のノード名。
messageType が 0 以外 (発話者が AIオペレータ以外) の場合、 または会話シナリオの対応する位置にノード名が存在しない場合には、このオブジェクトの内容は含まれません。
nodeType

string

発話の種別を示す、会話シナリオ中のノードタイプ。
messageType が 0 以外 (発話者が AIオペレータ以外) の場合、 または会話シナリオの対応する位置にノードタイプが存在しない場合には、このオブジェクトの内容は含まれません。
checkPoint

string

会話の到達位置を示す、会話シナリオ上のチェックポイント。
messageType が 0 以外 (発話者が AIオペレータ以外) の場合、 または会話シナリオの対応する位置にチェックポイントが存在しない場合には、このオブジェクトの内容は含まれません。
startMsec

integer

発話の開始時間を示す、通話開始からの時間 (ミリ秒)。
messageType が 0 (発話者が AIオペレータ) の場合、startMsec と endMsec は同じ値になる場合があります。
endMsec

integer

発話の終了時間を示す、通話開始からの時間 (ミリ秒)。
messageType が 0 (発話者が AIオペレータ) の場合、startMsec と endMsec は同じ値になる場合があります。
text

string

発話内容のテキスト。
dictation

string

発話内容の text を補足する、聞き取り文などのテキスト。

403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。

404 Not Found
リエクストのパス・パラメータで指定された コールID の 通話履歴情報が存在しないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。