合成実績取得 (ttscount)¶
合成実績の取得を行う API です。
合成実績取得 API¶
契約情報から当月の合成実績を取得します。
リクエスト¶
メソッド |
GET、POST |
URL |
|
リクエストパラメーター¶
名前 |
概要 |
必須 |
補足 |
|---|---|---|---|
username |
ユーザー名 |
○ |
詳細は契約情報をご確認ください。 |
password |
パスワード |
○ |
詳細は契約情報をご確認ください。 |
レスポンス¶
正常レスポンス¶
正常に処理された場合、HTTP ステータスコード 200 を返します。
合成実績データは XML 形式で返却します。
タグ名 |
概要 |
詳細 |
|---|---|---|
base_date |
集計基準日 |
リクエスト送信日が含まれる集計単位の開始日です。形式は yyyymmdd です。 |
base_count |
基本合成数 |
契約プランに応じた基本合成数です。フリープランの場合は 0 となります。 |
total_count |
総合計数 |
リクエスト送信時点までの総合成数です。 |
over_count |
超過合成数 |
基本合成数を超過した合成数です。 |
over_cost |
超過料金 |
超過合成数に対して発生する追加料金です。 |
over_flag |
超過状態 |
|
集計基準日 以外の項目は、契約開始日を基点とし、契約プランで定められた単位月ごとに 0 にリセットされます。
レスポンスボディーサンプル¶
<?xml version="1.0" encoding="UTF-8"?>
<webapi name="ja">
<base_date>2020/11/01</base_date>
<base_count>5000</base_count>
<total_count>6000</total_count>
<over_count>1000</over_count>
<over_cost>5000</over_cost>
<over_flag>1</over_flag>
</webapi>
エラーレスポンス¶
正常に処理できない場合の エラー通知 は共通です。
リクエスト例¶
curl プログラムによるリクエストの例を示します。
username を user、password を pass としています。
Windows (cmd.exe)¶
curl -s -v -XPOST -d "username=user&password=pass" ^
https://webapi.aitalk.jp/webapi/v5/ttscount.php
Linux (bash)¶
curl -s -v -XPOST -d "username=user&password=pass" \
https://webapi.aitalk.jp/webapi/v5/ttsget.php
