ユーザ登録API

ユーザ登録APIは、シナリオ対話APIを呼び出す際に必要となる「アプリID」を取得できます。
取得したアプリIDは、シナリオ対話APIで繰り返し利用できます。

ポイント

自然対話プラットフォームはアプリIDで対話相手を識別しており、異なるデバイスであってもアプリIDが同一であればPredicateなどの情報を共有することができます。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/UserRegistrationServer/users/applications

リクエスト

Method POST
Header Content-Type: application/json;charset=UTF-8
Body JSON形式(詳細はリクエストパラメータを参照)

レスポンス

Body JSON形式(詳細はレスポンスパラメータを参照)

リクエストパラメータ

アプリIDを取得するのに必要なパラメータです。JSON形式でリクエストします。

キー 必須 説明
botId string アプリIDを取得したいボットのIDを設定します。
appKind string "sunaba"固定。(現在は使用されていません)
notification boolean false固定。(現在は使用されていません)

※キーはスネークケースでも記述することができます。

Example

レスポンスパラメータ

取得したアプリIDです。JSON形式でレスポンスされます。

キー 必須 説明
app_id string 取得したアプリID。
Example

レスポンスパラメータ(エラー)

エラーが発生した際のレスポンスです。JSON形式でレスポンスされます。

キー 必須 説明
error String エラー内容。
Example

レスポンスコード

コード 意味
200 成功 送信成功
400 エラー パラメーター不正
404 サーバーなし
50x 送信失敗 サーバー内部エラー