概要
「ユーザー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-key | ◯ | String | マイプロジェクトのプロジェクト一覧画面に表示されている「APIキー」を指定。 |
---|
リクエストボディ
キー | 必須 | 型 | 説明 |
---|
botId | ◯ | String | 対話するボットのボットIDを指定。 マイプロジェクトのプロジェクト一覧/プロジェクト詳細画面に表示される「ボットID」。 |
---|
リクエスト例
POST https://api.repl-ai.jp/v1/registration
{
"botId":"Samplebot"
}
レスポンス(JSON)
キー | 必須 | 型 | 説明 |
---|
appUserId | ◯ | String | エンドユーザーごとに割り当てられるユーザーID。 |
---|
レスポンス例
{
"appUserId":"XXXXXXXXXXXXXXXXXXXXXXX"
}