共有音声を取得

共有ボイスのリストを取得します。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

page_sizeintegerオプションデフォルト値 30

返す共有音声の最大数です。100を超えることはできず、デフォルトは30です。

categoryenumオプション

フィルタリングに使用する音声カテゴリ

許可された値:
genderstring or nullオプション

フィルタリングに使用する性別

agestring or nullオプション

フィルタリングに使用する年齢

accentstring or nullオプション

フィルタリングに使用するアクセント

languagestring or nullオプション

フィルタリングに使用する言語

localestring or nullオプション

フィルタリングに使用するロケール

searchstring or nullオプション

絞り込みに使用する検索語

use_caseslist of strings or nullオプション

フィルタリングに使用するユースケース

descriptiveslist of strings or nullオプション

絞り込みに使用する検索語

featuredbooleanオプションデフォルト値 false

注目の音声でフィルタリングします

min_notice_period_daysinteger or nullオプション

指定した日数以上の最小事前通知期間を持つ音声をフィルタリングします。

include_custom_ratesboolean or nullオプション

カスタム料金の音声を含める/除外する

include_live_moderatedboolean or nullオプション

ライブモデレーション対象の音声を含める/除外する

reader_app_enabledbooleanオプションデフォルト値 false

Reader Appで有効な音声をフィルタリングします

owner_idstring or nullオプション

公開オーナーIDで音声をフィルタリングします

sortenumオプションデフォルト値 created_date

並べ替え条件です。created_date、usage_character_count_1y、trending、cloned_by_countのいずれかである必要があります。

許可された値:
pageintegerオプションデフォルト値 0

レスポンス

成功レスポンス。

voiceslist of objects

共有音声のリスト。

has_moreboolean

後続のページに共有音声がさらにあるかどうか。

total_countintegerオプションデフォルト値 0

クエリに一致する共有音声の合計数です。

last_sort_idstring or nullオプション

エラー

422
Unprocessable Entity Error