発信予約の登録
commubo が自動的に 顧客 へ発信する 発信予約 を新規に登録します。
リクエスト
POST <ベースURL>/v1/outgoings
リクエスト・ヘッダ
x-commubo-tenantId
stringrequired
commubo契約時に発行される、ご契約事業者さま固有のテナントID。
「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の
「設定 / テナント」メニューから確認できます。
x-commubo-accessToken
stringrequired
commubo契約時に発行される、ご契約事業者さま固有のアクセストークン。
「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の
「設定 / テナント」メニューから確認できます。
Content-type
stringrequired
"application/json" を指定してください。
リクエスト・ボディ
{
"phoneNumber": "0330001234",
"tryAfterDateTime": "2018-09-01T13:01:23+09:00",
"customer": {
"customerId": "0000AAAA-BBBB-CCCC-DDDD-EEEEFFFF11112222",
}
}
phoneNumber
stringrequired
発信先の電話番号。
電話番号は、数字、空白のほか、次の記号が指定できますが、実際に登録される電話番号は、自動的に空白や記号が取り除かれた数字のみの文字列となります。
* # + - . ( )
電話番号は、customerId で指定する 顧客 に登録されている電話番号以外を指定することも可能です。
電話番号は、数字、空白のほか、次の記号が指定できますが、実際に登録される電話番号は、自動的に空白や記号が取り除かれた数字のみの文字列となります。
* # + - . ( )
電話番号は、customerId で指定する 顧客 に登録されている電話番号以外を指定することも可能です。
tryAfterDateTime
stringrequired
発信を試みる日時。この時間以降に、発信のチャネルが空き次第に発信します。
現在時刻よりも過去の時間を指定した場合には、発信のチャネルが空き次第、直ちに発信されます。
日時は ISO 8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm) で指定してください。
現在時刻よりも過去の時間を指定した場合には、発信のチャネルが空き次第、直ちに発信されます。
日時は ISO 8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm) で指定してください。
customer
objectrequired
発信先の顧客のオブジェクト。
customerId
stringrequired
発信先の顧客のID。
curl コマンドにおける例
curl -X POST \
"https://connect.commubo.com:65536/v1/outgoings" \
-H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
-H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321" \
-H "Content-type: application/json" \
-d \
'
{
"phoneNumber": "0330001234",
"tryAfterDateTime": "2018-09-01T13:01:23+09:00",
"customer": {
"customerId": "0000AAAA-BBBB-CCCC-DDDD-EEEEFFFF11112222"
}
}
'
※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。
レスポンス
200 OK
リクエストが成功したことを示し、登録された発信予約の情報をレスポンス・ボディで返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
{
"phoneNumber": "0330001234",
"createdDateTime": "2018-09-01T13:01:23+09:00",
"updatedDateTime": "2018-09-01T13:01:23+09:00",
"tryAfterDateTime": "2018-09-01T13:01:23+09:00",
"retryCount": "0",
"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"
}
}
phoneNumber
string
発信先の電話番号。
createdDateTime
string
発信予約を登録した日時。
updatedDateTime
string
発信予約の情報を更新(登録)した日時。
tryAfterDateTime
string
発信を試みる日時。この時間以降に、発信のチャネルが空き次第に発信します。
retryCount
integer
発信先が話中(ビジー)等で、再発信を試みている回数。
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オペレータ管理 / 会話シナリオ」メニューから確認できます。
403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
406 Not Acceptable
リクエストの内容が不足していたり、不整合な情報が含まれていることを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。