テレフォニー・ユーティリティAPI¶
テレフォニー・ユーティリティAPIは電話とインターネットの情報操作にいろいろ便利なAPI群です。
携帯電話事業者確認¶
携帯電話事業者確認するには、 POST リクエストをエンドポイントに行ってください。
https://api.xoxzo.com/utilities/carrierlookup/
下記のパラメーターを併記してください。
名称
詳細
必須
データタイプ
例
recipient
確認する携帯番号
○
E.164
+8190123456789
注釈
recipient パラメーターに関する注意点
例¶
下記は、CURLを使ったリクエストの例です。
curl -u <SID>:<AUTH_TOKEN> --data-urlencode 'recipient=<recipient>' https://api.xoxzo.com/utilities/carrierlookup/
レスポンスは、JSON構造となり、ステータスコード HTTP 201 CREATED にて返されます。
HTTP/1.1 201 CREATED
Content-Type: application/json
[
{
"id": "gyt5rrrrrrrrrrr65rfsr43rrrrujgf4"
"mcc": "440",
"mnc": "54",
"mccmnc": "44054",
"carrier": "KDDI",
"country": "JP",
"recipient": "+8190123456789"
"cost": 5,
}
]
携帯電話事業者を特定できなかった場合、以下のようなレスポンスが返されます。
HTTP/1.1 201 Created
Content-Type: application/json
[
{
"carrier": null,
"cost": 5,
"country": null,
"id": "SPsxrrrrmdCopjYgynTRXrrrrrrDkrrr",
"mcc": null,
"mccmnc": null,
"mnc": null,
"recipient": "+8133333333"
}
]
レスポンスデータ¶
名称
詳細
id
このリクエストを特定するための32文字数のIDです。
mcc
モバイル国別コード
mnc
モバイルネットワーク別コード
mccmnc
事業者を特定できる mccmnc コード (mccとmncの組み合わせのコード)
carrier
携帯電話事業者の商号
country
この携帯電話事業者のISO Alpha-2の国コード
recipient
確認しようとしている携帯番号
cost
このリクエストで消費したクレジット
注釈
mccmnc データに関する注意点
MCCとMNCの組み合わせ で世界のどの携帯事業者でも特定することは可能です。
合併などで事業者の商号が変わることがありますが、MCCMNCコードはほとんど変わりません。
１つの事業者に複数のMCCMNCコードを割り当てられる場合があります。
間違ったバラメーターが与えられた場合には、ステータスコード HTTP 400 BAD REQUEST が返されます。例えば、もし recipient パラメーターがなかった場合、HTTPからの返答はこのようになります。
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json
{
"recipient": [
"This field is required."
]
}
テキスト読み上げ機能¶
テキスト読み上げ機能は、音声通話APIの追加機能です。それ自体は単独の機能ではありません。
テキスト読み上げ機能を使うためには、それぞれ必要な文書を参照する必要があります。APIには音声への変換機能のための、特別なパラメータがあります。
音声プレーバックAPIでのテキスト読み上げ機能¶
警告
追加の料金が発生します。詳しくは 料金ページ を参照してください。
電話を発信し、相手が電話を取った時にテキストを再生するには、エンドポイントに POST リクエストを行ってください。
https://api.xoxzo.com/voice/simple/playbacks/
下記のパラメーターを併記してください。
名称
詳細
必須
データタイプ
例
caller
発信者番号
○
数字
+8190123456789
recipient
通話の受信者
○
E.164
+8190123456789
tts_message
再生するテキスト
○
UTF-8
みなさん、こんにちは！
tts_lang
テキストの言語
○
ISO 639-1
en
注釈
tts_message パラメーターに関する注意点
音声合成に使用する、UTF-8のテキスト。
最大長は 250文字です。
このパラメータと同時に recording_url パラメータを指定することはできません。
注釈
tts_lang パラメーターに関する注意点
tts_message の言語を示す、２文字の ISO 639-1. コード。
tts_message を使ったときは、このパラメータを指定しなければいけません。
サポートされている言語
言語コード
言語
ja
日本語
en
英語
例¶
下記は、CURLを使ったリクエストの例です。
curl -u <SID>:<AUTH_TOKEN>
--data-urlencode 'caller=<caller>' \
--data-urlencode 'recipient=<recipient>' \
--data-urlencode 'tts_message=おはよう' \
--data-urlencode 'tts_lang=ja' \
https://api.xoxzo.com/voice/simple/playbacks/
ちなみに
実際にテストコードでAPIを叩いたほうが早く動作確認できます。 無料登録 は無料ですぐできます。
レスポンスデータ¶
レスポンスに関しては 音声プレーバックAPI を参照してください。