API 概要¶
AITalk WebAPI の API の概要です。
AITalk WebAPI 機能一覧¶
AITalk WebAPI が提供する機能の一覧と概要です。
機能名 |
概要 |
---|---|
音声合成・言語処理を行います。 |
|
合成実績の取得を行います。 |
プロトコル¶
AITalk WebAPI の機能は HTTPS を通じて利用します。 以下の通信プロトコルに対応します。
項目 |
説明 |
---|---|
通信プロトコル |
HTTP/1.1 (HTTP/1.1 の全ての機能に対応しているわけではございません) |
対応メソッド |
GET, POST |
文字コード |
UTF-8 |
出力データ形式 |
|
メソッド¶
各機能の利用にはそれぞれ異なったパスを指定します。
また、機能毎に利用可能なメソッドが異なります。
機能とパス・対応メソッドの一覧を次に示します。
機能名 |
URL |
GET |
POST |
---|---|---|---|
webapi.aitalk.jp/webapi/v5/ttsget.php |
○ |
○ |
|
webapi.aitalk.jp/webapi/v5/ttscount.php |
○ |
○ |
HTTP ヘッダー¶
AITalk WebAPI の扱う HTTP ヘッダーを説明します。
リクエストヘッダー¶
AITalk WebAPI が受け取るリクエストヘッダーを次に示します。
ヘッダー名 |
説明 |
---|---|
Host |
HTTP/1.1 では必須です。必ず値を指定してください。 |
レスポンスヘッダー¶
AITalk WebAPI が返信するレスポンスヘッダーを次に示します。
ヘッダー名 |
説明 |
---|---|
Cache-Control |
常時 |
Content-Length |
レスポンスボディーのサイズが設定されます。 |
Content-Type |
レスポンスボディーのデータ型が設定されます。 |
Date |
サーバーがリクエストを受け付けた時刻が設定されます。 |
エラー通知¶
AITalk WebAPI は、HTTP ステータスコード および レスポンスボディーでエラーを通知します。
下記の HTTP ステータスコード および レスポンスボディー、エラーコードは全ての機能で共通です。
HTTP ステータスコード¶
コード |
エラー概要 |
---|---|
401 |
認証結果が正しくありません。 |
500 |
指定のジョブは実行できません。各パラメーターが正しいかを確認してください。 |
503 |
サーバーの問題でリクエストを受け付けられません。 |
レスポンスボディ¶
レスポンスボディーは XML 形式で返却します。
タグ名 |
概要 |
詳細 |
---|---|---|
code |
AITalk WebAPI 独自のコードです。 |
|
message |
エラーメッセージ |
AITalk WebAPI 独自のエラーメッセージです。 |
detail |
エラー詳細メッセージ |
エラー詳細情報がある場合のみ記載されます。 |
以下に例を示します。
<?xml version="1.0" encoding="UTF-8"?>
<webapi>
<code>9999</code>
<message>tts engine failed</message>
<detail>CheckParam error</detail>
</webapi>
エラーコード¶
コード |
エラー概要 |
---|---|
1001 |
正しい話者が指定されていません。 |
1002 |
正しいパスワードが指定されていません。 |
1003 |
正しいパラメーターが指定されていません。 |
1004 |
存在しない音声ファイルにアクセスしようとしています。 |
1005 |
合成文字列が長過ぎます。1 度に合成可能な文字数については契約情報を確認してください。 |
1101 |
認証に失敗しました。 |
1102 |
契約期間外のアクセスです。 |
1103 |
月間合成文字数を超過しています。合成可能文字数については契約情報を確認してください。 |
1201 |
合成サーバーへのアクセスに失敗しました。(LB) |
1202 |
合成に失敗しました。パラメーターが正しく設定されているか確認してください。特に |
1203 |
データベース処理に失敗しました。 |
1204 |
データ送信に失敗しました。 |
1205 |
合成サーバーへのアクセスに失敗しました。 |
9999 |
予期せぬエラーが発生しました。 |