AIオペレータの登録
commubo へ AIオペレータ を新たに登録します。
リクエスト
POST <ベースURL>/v1/operators
リクエスト・ヘッダ
x-commubo-tenantId
stringrequired
commubo契約時に発行される、ご契約事業者さま固有のテナントID。
「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の
「設定 / テナント」メニューから確認できます。
x-commubo-accessToken
stringrequired
commubo契約時に発行される、ご契約事業者さま固有のアクセストークン。
「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の
「設定 / テナント」メニューから確認できます。
Content-type
stringrequired
"application/json" を指定してください。
リクエスト・ボディ
登録する AIオペレータ の情報を指定します。
{
"operatorVoiceId": "123",
"name": "AIオペレータのコミュボ",
"nameKana": "エーアイオペレータノコミュボ",
"shortName": "コミュボ",
"shortNameKana": "コミュボ",
"orgName": "株式会社ソフトフロントホールディングス",
"orgNameKana": "ガイシャソフトフロントホールディングス",
"orgShortName": "ソフトフロント",
"orgShortNameKana": "ソフトフロント",
"deptName": "研究開発",
"deptNameKana": "ケンキュウカイハツ",
"deptShortName": "R&D",
"deptShortNameKana": "アールアンドディー"
}
operatorVocieId
integerrequired
AIオペレータの「音声」のタイプを識別する、AIオペレータ音声のID。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / AIオペレータ音声」メニューから確認できます。
IDの値は「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「AIオペレータ管理 / AIオペレータ音声」メニューから確認できます。
name
stringrequired
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オペレータの短縮部門名の読み仮名の文字列 (カタカナ)。
curl コマンドにおける例
AIオペレータの登録
curl -X POST \
"https://connect.commubo.com:65536/v1/operators" \
-H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
-H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321" \
-H "Content-type: application/json" \
-d \
'
{
"operatorVoiceId": "123",
"name": "AIオペレータのコミュボ",
"nameKana": "エーアイオペレータノコミュボ",
"shortName": "コミュボ",
"shortNameKana": "コミュボ",
"orgName": "株式会社ソフトフロントホールディングス",
"orgNameKana": "ガイシャソフトフロントホールディングス",
"orgShortName": "ソフトフロント",
"orgShortNameKana": "ソフトフロント",
"deptName": "研究開発",
"deptNameKana": "ケンキュウカイハツ",
"deptShortName": "R&D",
"deptShortNameKana": "アールアンドディー"
}
'
※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。
レスポンス
200 OK
リクエストが成功したことを示し、登録されたAIオペレータの情報をレスポンス・ボディで返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
AIオペレータのオブジェクトが返ります。
{
"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": "アールアンドディー"
}
operatorId
string
登録されたAIオペレータのID。
createdDateTime
string
AIオペレータを登録した日時。
updatedDateTime
string
AIオペレータの情報を更新(登録)した日時。
operatorVocieId
integer
AIオペレータの「音声」のタイプを識別する、AIオペレータ音声のID。
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オペレータの短縮部門名の読み仮名の文字列 (カタカナ)。
403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
406 Not Acceptable
リクエストの内容が不足していたり、不整合な情報が含まれていることを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。