ホーム API/ツール API 音声合成

音声合成

    音声合成APIは、テキストを受け付け、その入力に対して自然な感じの読み上げをする機能を提供します。

    API
    基本情報

    ■エーアイ

    提供 : REST, SDK(Android™,iOS,Server side JAVA)

    ■HOYA

    提供 : REST

    ■NTTテクノクロス

    提供 : REST

    法人情報登録あり : 利用可[制限なし]

    法人情報登録なし : 利用可[制限あり]

    利用条件 : あり※1

    ※1「ガイドライン(必読)」に記載の利用条件に予め同意していただく必要がございます。

    ご利用いただくためには「アカウント登録(無料)」が必要です。

    リファレンスを参照するAPI機能名を選択してください

    カナアクセント文


    • カタカナの読みの記述や、アクセント位置・ポーズ長を設定可能で、自在な音声の読み上げが可能です。

    リクエストURL

    • 法人情報登録者専用

    https://api.apigw.smt.docomo.ne.jp/crayonCorp/v1/textToSpeechKanaAccent

    ※法人情報登録はこちらから無料で登録可能です。

    • 一般開発者用

    https://api.apigw.smt.docomo.ne.jp/crayon/v1/textToSpeechKanaAccent

    メソッド : POST
    文字コード : UTF-8

    リクエストヘッダ

    キー 必須 説明
    Content-Type 送信データのMIMEタイプは、下記を指定。
    application/json : JSON形式

    リクエストクエリパラメータ

    キー 必須 説明
    APIKEY APIにアクセスするアプリの認証に利用する。

    リクエストボディ

    キー 必須 説明
    Command APIで利用するコマンドは、下記を指定。
    AP_Synth
    SpeakerID 話者は、下記のいずれかを指定。
    1 : あおい(元気なお姉さん)
    2 : さくら(ハスキーなお姉さん)
    3 : ゆい(女性)
    4 : はづき(落ち着いている女性)
    5 : くみこ(おばさん)
    6 : はな(お婆さん)
    7 : あいり(女の子)
    8 : ひまり(メイド)
    9 : つよし(癒やし系お兄さん)
    10: けいすけ(くだけたお兄さん)
    11: かずひろ(男性)
    12: しろう(おじさん)
    13: しんいち(男の子)
    14: たつや(執事)
    15: ひとし(謎の男性)
    法人情報を登録してない場合は、1と14のみ利用可能。
    StyleID 口調は、下記のいずれかを指定。
    1 : あおい(元気なお姉さん)
    2 : さくら(ハスキーなお姉さん)
    3 : ゆい(女性)
    4 : はづき(落ち着いている女性)
    5 : くみこ(おばさん)
    6 : はな(お婆さん)
    7 : あいり(女の子)
    8 : ひまり(メイド)
    9 : つよし(癒やし系お兄さん)
    10: けいすけ(くだけたお兄さん)
    11: かずひろ(男性)
    12: しろう(おじさん)
    13: しんいち(男の子)
    14: たつや(執事)
    15: ひとし(謎の男性)
    法人情報を登録してない場合は、1と14のみ利用可能。
    SpeechRate - 話速を指定(小数点第二位まで指定可能)。
    (遅い) 0.50~10.00 (速い)
    省略時 : 1.00
    PowerRate - 音量を指定(小数点第二位まで指定可能)。
    (小さい) 0.00~5.00 (大きい)
    省略時 : 1.00
    VoiceType - 声質は、下記のいずれかを指定。
    (太い) 0.50~2.00 (細い)
    省略時 : 1.00
    AudioFileFormat - 音声ファイルフォーマットは、下記のいずれかを指定。
    0 : AAC、22,050Hz (省略時)
    1 : Ogg Vorbis、22,050Hz
    2 : 16bit LinearPCM Wave、22,050Hz
    3 : 8bit μ-law、8,000Hz
    TextData 音声合成対象のテキスト形式は、カナアクセント文を指定。
    サンプル値) エヌティーティーノ[/05]オンセーゴーセーエンジンニ[*09]ヨル[/00]オンセーデス^[.01]
    ※カナアクセント文仕様については、API仕様書を参照。

    レスポンスヘッダ

    キー 必須 説明
    X-ProtocolVersion プロトコルのバージョン。
    サンプル値) d-1.0.0
    X-ResponseCode レスポンコードは、下記のいずれかが返却される。
    200 OK : 正常
    200 OK以外 : 異常
    ※200 OK以外は、下記"レスポンスコード詳細"を参照。
    Content-Type 受信データのMIMEタイプは、下記のいずれかが返却される。
    audio/aac : AAC
    audio/ogg : Ogg Vorbis
    audio/wav : WAVE
    X-Content-Length 音声データのサイズが返却される(単位はbyte)。

    レスポンスボディ

    キー 必須 説明
    - 音声データ。

    リクエストサンプル

    POST https://api.apigw.smt.docomo.ne.jp/crayonCorp/v1/textToSpeechKanaAccent?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    
    ※法人情報登録者専用のリクエストURLを使用しております。
    Content-Type:application/json
    
    {
      "Command":"AP_Synth",
      "SpeakerID":"1",
      "StyleID":"1",
      "SpeechRate":"1.15",
      "AudioFileFormat":"0",
      "TextData":"エヌティーティーノ[/05]オンセーゴーセーエンジンニ[*09]ヨル[/00]オンセーデス^[.01]"
    }
    

    レスポンスサンプル

      HTTP/1.1 200 OK
      X-Protocol-Version: d-1.0.0
      X-ResponseCode: 200 OK
      X-Content-Length: 10000
      Content-Type: audio/aac
    
      音声データ(Binary)
    

    レスポンスコード詳細

    レスポンスコード
    (X-ResponseCode)
    名前 説明
    200 OK コマンドが正常に処理し完了。
    400 NG コマンドに対して、正常に処理ができない。
    401 Command Not Supported サポートしていないコマンド、引数が不正。
    402 Request Size Over 送信データが最大サイズオーバー。
    416 Data Change Failure URLデコードおよび文字コード変換に失敗。
    418 User Max Connect Over WebAPIのアクセス数上限を超過。
    430 Illegal Text 合成対象テキストが不正。
    431 Illegal Read カナアクセント文のフォーマットが不正。
    432 Synth Text Max Size Over 漢字かな混じり文の最大サイズオーバー。
    435 Failed To Deploy SSML SSMLタグの展開に失敗。
    440 Ilegal Parameter 不正なパラメータ。
    441 Illegal Value 不正なパラメータ値。
    442 Parameter Not Exist パラメータが存在しない。
    470 TTS Open Error 音声合成サーバのチャネルオープン時にエラー。
    471 TTS TextAna Error 音声合成サーバのテキスト解析処理時にエラー。
    472 TTS Synth Error 音声合成サーバの音声合成処理時にエラー。
    473 TTS Close Error 音声合成サーバのチャネルクローズ時にエラー。
    474 TTS Not Exist 音声合成サーバが存在しない。
    475 TTS Comm Error 音声合成サーバとの通信エラー。
    476 TTS Over Connect 音声合成サーバが最大接続数オーバー。
    477 Customer Over Max Connect 最大接続可能数をオーバー。
    478 TTS Internal Error 音声合成サーバで内部エラーが発生。
    479 TTS Exception Error 音声合成サーバで例外が発生。
    498 WebAPI Internal Error 本APIで内部エラーが発生。
    500 Server Error 音声合成サーバ側の問題で処理が継続できない。
    502 Server Busy 音声合成サーバが混雑していて処理が実行できない。
    510 DB Operation Faild DBの操作に失敗。
    511 Entry Already Exist 指定データが重複。
    512 Entry Not Exist 指定データが存在しない。
    514 Update Failure 更新処理に失敗。
    515 Lock Failure ロックの取得に失敗。
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。