ユーザ登録単語用クラス名(公開予定)

ユーザ登録単語用クラス名一覧を取得します。

注意

2024年9月下旬ごろに公開予定のAPIです。先行して仕様を公開しています。

エンドポイント

GET https://acp-api.amivoice.com/classnames/<dgn>

認証

APPKEY はAuthorizationヘッダーに指定してください。

Authorization: Bearer {APPKEY}

リクエストパラメータ

パラメータ名	パラメータ名	注記
dgn	接続エンジン名	-a-generalなどの接続エンジン名を指定します。指定できる値は音声認識エンジンの一覧を参照してください。パスパラメータとして設定します。
adf	音声データ形式	16kまたは8kのいずれかを指定します。指定しない場合は16kとなります。音声認識エンジンによっては複数のサンプリングレートに対応していますが、単語登録は8k、16kでそれぞれ異なるエンジンとしてとりあつかうためにどちらかを指定する必要があります。クエリパラメータとして設定します。

レスポンス

成功時

HTTPステータスコード: 200 OK

レスポンスボディ

フィールド名	説明	補足
classnames	クラス名	クラス名が配列形式で得られます

例

{
    "classnames":
        [
            "固有名詞",
            "名前",
            "名前(名)",
            "駅名",
            "地名",
            "会社名",
            "部署名",
            "役職名",
            "記号",
            "括弧開き",
            "括弧閉じ",
            "元号"
        ]
}

失敗時

HTTPステータスコード: 200以外

レスポンスボディ

フィールド名	説明	補足
code	エラーコード	エラーの種別を示すコード
message	エラーメッセージ	エラー内容の詳細を説明するテキスト

エラーコードとエラーメッセージ

HTTPステータスコード	レスポンスボディ	エラーの状況
404 Not Found	{"code":"?","message":"missing dictation grammar file name"}	ディクテーショングラマファイル名 <dgn> が指定されていない時
405 Method Not Allowed	{"code":"?","message":"POST method is not allowed"}	POST が指定された時
401 Unauthorized	{"code":"-","message":"can't verify service authorization"}	サービス認証キー文字列の認証に失敗した時
401 Unauthorized	{"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"}	サービス認証キー文字列の認証に失敗した時
500 Internal Server Error	{"code":"?","message":"unexpected exception occurred (<optionalMessage>)"}	想定外の例外が発生した時

例

{
    "code":"?",
    "message":"missing dictation grammar file name"
}