通話履歴情報の取得
指定した 通話履歴 の情報を取得します。
リクエスト
GET <ベースURL>/v1/calls/{callId}
パス・パラメータ
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" \
-H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
-H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321"
※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。
レスポンス
200 OK
リクエストが成功したことを示し、通話履歴の情報をレスポンス・ボディで返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
通話履歴のオブジェクトが返ります。
{
"callId": "1234567890123456",
"callType": "0",
"relatedCallId": "9876543210987654",
"phoneNumber": "0330001234",
"callDateTime": "2018-09-01T13:01:23+09:00",
"connectedDateTime": "2018-09-01T13:01:23+09:00",
"talkTime": "123",
"connectResult": "SUCCESSFUL",
"checkPoint": "abcdefg",
"customer": {
"customerId": "0000AAAA-BBBB-CCCC-DDDD-EEEEFFFF11112222",
"createdDateTime": "2018-09-01T13:01:23+09:00",
"updatedDateTime": "2018-09-01T13:01:23+09:00",
"familyName": "鈴木",
"familyNameKana": "スズキ",
"personalName": "一郎",
"personalNameKana": "イチロウ",
"middleName": "スミス",
"middleNameKana": "スミス",
"phoneNumbers": [
"0330001234"
],
"orgName": "エーアイ化粧品株式会社",
"orgNameKana": "エーアイケショウヒンカブシキガイシャ",
"orgShortName": "エーアイ化粧品",
"orgShortNameKana": "エーアイケショウヒン",
"deptName": "経営企画部",
"deptNameKana": "経営企画部",
"deptShortName": "経企",
"deptShortNameKana": "ケイキ",
"note": "あいうえお"
},
"operator": {
"operatorId": "11112222-3333-4444-5555-6666777788889999",
"createdDateTime": "2018-09-01T13:01:23+09:00",
"updatedDateTime": "2018-09-01T13:01:23+09:00",
"operatorVoiceId": "123",
"name": "AIオペレータのコミュボ",
"nameKana": "エーアイオペレータノコミュボ",
"shortName": "コミュボ",
"shortNameKana": "コミュボ",
"orgName": "株式会社ソフトフロントホールディングス",
"orgNameKana": "ガイシャソフトフロントホールディングス",
"orgShortName": "ソフトフロント",
"orgShortNameKana": "ソフトフロント",
"deptName": "研究開発",
"deptNameKana": "ケンキュウカイハツ",
"deptShortName": "R&D",
"deptShortNameKana": "アールアンドディー"
},
"scenario": {
"scenarioId": "FFFFEEEE-DDDD-CCCC-BBBB-AAAA000099998888"
},
"note": "あいうえお"
}
callId
string
個々の通話を識別するコールID。
callType
integer
通話の種別を、次の値により示します。
relatedCallId
string
会話シナリオによる転送や、ユーザーコールなどで、他のコールから派生した通話である場合の、派生元のコールID。
派生元のコールが存在しない、通常のコールの場合には、この情報は含まれません。
派生元のコールが存在しない、通常のコールの場合には、この情報は含まれません。
phoneNumber
string
コールの相手先の電話番号。
callDateTime
string
コールが発生 (発信または着信) した日時。
connectedDateTime
string
相手先とのコールが成立した (繋がった) 日時。
相手先と繋がらなかった場合には、この情報は含まれません。
相手先と繋がらなかった場合には、この情報は含まれません。
talkTime
integer
相手先との通話時間 (秒)。
相手先と繋がらなかった場合には、この情報は含まれません。
相手先と繋がらなかった場合には、この情報は含まれません。
connectResult
string
checkPoint
string
会話シナリオに従って相手先と交わされた会話にて、最後に通過した会話シナリオ上のチェックポイント。
相手先と繋がらなかった場合や、会話シナリオ上にチェックポイントが存在しなかった、または通過しなかった場合には、この情報は含まれません。
相手先と繋がらなかった場合や、会話シナリオ上にチェックポイントが存在しなかった、または通過しなかった場合には、この情報は含まれません。
customer
object
通話相手先の顧客のオブジェクト。
顧客 として登録されていない電話番号から着信した場合など、顧客情報が存在しなかった場合には、このオブジェクトは含まれません。
顧客 として登録されていない電話番号から着信した場合など、顧客情報が存在しなかった場合には、このオブジェクトは含まれません。
customerId
string
顧客のID。
個々の顧客を識別するIDです。
個々の顧客を識別するIDです。
createdDateTime
string
顧客を作成(登録)した日時。
updatedDateTime
string
顧客の情報を更新した日時。
familyName
string
顧客の姓の文字列。
familyNameKana
string
顧客の姓の読み仮名の文字列 (カタカナ)。
personalName
string
顧客の名の文字列。
personalNameKana
string
顧客の名の読み仮名の文字列 (カタカナ)。
middleName
string
顧客のミドルネームの文字列。
middleNameKana
string
顧客のミドルネームの読み仮名の文字列 (カタカナ)。
phoneNumbers
string array
顧客の電話番号のリスト (最大5個)。
orgName
string
顧客の組織名の文字列。
orgNameKana
string
顧客の組織名の読み仮名の文字列 (カタカナ)。
orgShortName
string
顧客の短縮組織名の文字列。
orgShortNameKana
string
顧客の短縮組織名の読み仮名の文字列 (カタカナ)。
deptName
string
顧客の部門名の文字列。
deptNameKana
string
顧客の部門名の読み仮名の文字列 (カタカナ)。
deptShortName
string
顧客の短縮部門名の文字列。
deptShortNameKana
string
顧客の短縮部門名の読み仮名の文字列 (カタカナ)。
note
string
顧客の備考情報。
operator
object
通話相手先と会話したAIオペレータのオブジェクト。
operatorId
string
AIオペレータのID。
個々のAIオペレータを識別するIDです。
個々のAIオペレータを識別するIDです。
createdDateTime
string
AIオペレータを作成(登録)した日時。
updatedDateTime
string
AIオペレータの情報を更新した日時。
operatorVocieId
integer
AIオペレータの「音声」のタイプを識別する、AIオペレータ音声のID。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / AIオペレータ音声」メニューから確認できます。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / AIオペレータ音声」メニューから確認できます。
name
string
AIオペレータの名前の文字列。
nameKana
string
AIオペレータの名前の読み仮名の文字列 (カタカナ)。
shortName
string
AIオペレータの短縮名の文字列。
shortNameKana
string
AIオペレータの短縮名の読み仮名の文字列 (カタカナ)。
orgName
string
AIオペレータの組織名の文字列。
orgNameKana
string
AIオペレータの組織名の読み仮名の文字列 (カタカナ)。
orgShortName
string
AIオペレータの短縮組織名の文字列。
orgShortNameKana
string
AIオペレータの短縮組織名の読み仮名の文字列 (カタカナ)。
deptName
string
AIオペレータの部門名の文字列。
deptNameKana
string
AIオペレータの部門名の読み仮名の文字列 (カタカナ)。
deptShortName
string
AIオペレータの短縮部門名の文字列。
deptShortNameKana
string
AIオペレータの短縮部門名の読み仮名の文字列 (カタカナ)。
scenario
object
通話相手先と会話したシナリオのオブジェクト。
scenarioId
string
会話シナリオのID。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / 会話シナリオ」メニューから確認できます。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / 会話シナリオ」メニューから確認できます。
note
string
通話の備考情報。
403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
404 Not Found
リエクストのパス・パラメータで指定された コールID の 通話履歴情報が存在しないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。