発信コールの通知
登録した発信予約のそれぞれに対して、commubo が自動的に発信する際に、commubo から呼びだれます。
APIの応答によって、その発信処理を継続するか中止するかを、commubo へ指示できます。 200成功応答の場合は発信処理は継続されますが、300以降のすべてのエラー応答を返した場合には、commubo は発信処理を中止します。
コールバックAPI は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / 会話シナリオ」メニューから登録できます。 コールバックAPIが登録されていない場合は、commubo は発信処理を継続します。
APIの応答によって、その発信処理を継続するか中止するかを、commubo へ指示できます。 200成功応答の場合は発信処理は継続されますが、300以降のすべてのエラー応答を返した場合には、commubo は発信処理を中止します。
コールバックAPI は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / 会話シナリオ」メニューから登録できます。 コールバックAPIが登録されていない場合は、commubo は発信処理を継続します。
「commubo connect ご契約ユーザーさま ダッシュボード・ページ」で、
コールバックAPIが登録されている場合、commubo はコールバックAPIの呼び出しに失敗すると、発信処理を中止します。
メンテナンス等で、お客様アプリケーションのAPIサーバーを停止する場合など、発信予約の状況に注意してください。
リクエスト
POST <お客様アプリケーションのAPIエンドポイントのURL>
リクエスト・ヘッダ
Content-type
stringrequired
"application/json" が指定されます。
リクエスト・ボディ
発信するコールの情報が送られます。
{
"callId": "1234567890123456",
"callType": "0",
"relatedCallId": "9876543210987654",
"phoneNumber": "0330001234",
"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"
}
}
callId
string
個々の通話を識別するコールID。
callType
integer
通話の種別を、次の値により示します。
relatedCallId
string
会話シナリオによる転送や、ユーザーコールなどで、他のコールから派生した通話である場合の、派生元のコールID。
派生元のコールが存在しない、通常のコールの場合には、この情報は含まれません。
派生元のコールが存在しない、通常のコールの場合には、この情報は含まれません。
phoneNumber
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オペレータ管理 / 会話シナリオ」メニューから確認できます。
レスポンス
200 OK
発信処理の継続を指示します。
レスポンス・ヘッダ
レスポンス・ヘッダは必要ありません。
レスポンス・ボディ
レスポンス・ボディは必要ありません。
300 以降のエラー応答
発信処理の中止を指示します。
レスポンス・ヘッダ
レスポンス・ヘッダは必要ありません。
レスポンス・ボディ
レスポンス・ボディは必要ありません。