ユーザーID取得

概要

「ユーザーID取得」では、ボットと話すために必要なユーザーIDを取得できます。 ユーザーIDとは、ボットが話している相手(エンドユーザー)が誰かを理解するために必要なIDです。 ボットはユーザーIDにひもづけて、話し相手の情報や会話のステータスを覚えるため、「対話」を利用開始する前に、必ずユーザーIDを取得してください。

プロトコルHTTP
文字コードUTF-8
リクエストURL https://api.repl-ai.jp/v1/registration
HTTPメソッドPOST

リクエストヘッダ

キー必須説明
Content-Typeリクエストボディのコンテンツタイプを指定。
application/jsonを指定。
x-api-keyStringマイプロジェクトのプロジェクト一覧画面に表示されている「APIキー」を指定。

リクエストボディ

キー必須説明
botIdString対話するボットのボットIDを指定。
マイプロジェクトのプロジェクト一覧/プロジェクト詳細画面に表示される「ボットID」。

リクエスト例

POST https://api.repl-ai.jp/v1/registration

{
"botId":"Samplebot"
}

レスポンス(JSON)

キー必須説明
appUserIdStringエンドユーザーごとに割り当てられるユーザーID。

レスポンス例

{
"appUserId":"XXXXXXXXXXXXXXXXXXXXXXX"
}

エラーレスポンス

HTTP主要ステータスコード

ステータスコード説明
200 OK成功応答
400 Bad Requestリクエストパラメータ不正
500 Internal Server Errorサーバ内部エラー
読込中...