空き番号検索

このページでは、購入可能な Numbers をプログラムで検索する方法を紹介します。

また、オンラインで利用可能な Numbers を検索することもできます。開発者ダッシュボードまたはコマンドラインから Vonage CLI.

サンプルコードの以下の変数を、独自の値に置き換えてください：

キー	説明
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`COUNTRY_CODE`	The two digit country code for the number. For example: `GB` for the United Kingdom
`VONAGE_NUMBER_TYPE`	The type of number: `landline`, `mobile-lvn` or `landline-toll-free`
`VONAGE_NUMBER_FEATURES`	The capabilities of the number: `SMS`, `VOICE` or `SMS,VOICE` for both
`NUMBER_SEARCH_CRITERIA`	The filter criteria. For example, numbers containing `234`.
`NUMBER_SEARCH_PATTERN`	Where the `NUMBER_SEARCH_CRITERIA` should appear in the number: `0` - At the beginning of the number `1`- Anywhere in the number `2` - At the end of the number

コードを書く

search-numbers.sh に以下を追加する：

curl \
  -u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
  "https://rest.nexmo.com/number/search?country=$COUNTRY_CODE&type=$VONAGE_NUMBER_TYPE&features=$VONAGE_NUMBER_FEATURES&pattern=$NUMBER_SEARCH_CRITERIA&search_pattern=$NUMBER_SEARCH_PATTERN"

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

sh search-numbers.sh

前提条件

npm install @vonage/server-sdk

search-numbers.js という名前のファイルを作成し、以下のコードを追加する：

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

全文を見る

コードを書く

search-numbers.js に以下を追加する：

vonage.numbers.getOwnedNumbers({
  country: COUNTRY_CODE,
  type: VONAGE_NUMBER_TYPE,
  pattern: NUMBER_SEARCH_CRITERIA,
  searchPattern: NUMBER_SEARCH_PATTERN,
  features: VONAGE_NUMBER_FEATURES,
})
  .then((numbers) => {
    for (const number of numbers) {
      console.log(number);
    }
  })
  .catch((error) => console.error(error));

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

node search-numbers.js

前提条件

build.gradle に以下を追加する：

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

SearchAvailableNumbers という名前のファイルを作成し、main メソッドに以下のコードを追加する：

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

全文を見る

コードを書く

SearchAvailableNumbers ファイルのmain メソッドに以下を追加する：

val numbers = client.numbers.searchAvailable {
    country(NUMBER_COUNTRY_CODE)
    type(NUMBER_TYPE)
    features(*NUMBER_FEATURES)
    pattern(NUMBER_SEARCH_PATTERN, NUMBER_SEARCH_CRITERIA)
}
for (number in numbers) {
    println("""
        Tel: ${number.msisdn}
        Country: ${number.country}
        Type: ${number.type}
        Cost: ${number.cost}
        """.trimIndent()
    )
}

全文を見る

コードを実行する

Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する：

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

以下のgradle コマンドを実行し、com.vonage.quickstart.kt.numbers をSearchAvailableNumbers を含むパッケージに置き換えてアプリケーションを実行する：

gradle run -Pmain=com.vonage.quickstart.kt.numbers.SearchAvailableNumbers

前提条件

build.gradle に以下を追加する：

implementation 'com.vonage:server-sdk:9.3.1'

SearchNumbers という名前のファイルを作成し、main メソッドに以下のコードを追加する：

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

全文を見る

コードを書く

SearchNumbers ファイルのmain メソッドに以下を追加する：

SearchNumbersResponse response = client.getNumbersClient().searchNumbers(
        SearchNumbersFilter.builder()
            .country(NUMBER_COUNTRY_CODE)
            .type(NUMBER_TYPE)
            .features(NUMBER_FEATURES)
            .pattern(NUMBER_SEARCH_PATTERN, NUMBER_SEARCH_CRITERIA)
            .build()
);

System.out.println("Here are "
        + response.getNumbers().length
        + " of the " + response.getCount()
        + " matching numbers available for purchase."
);

for (AvailableNumber number : response.getNumbers()) {
    System.out.println("Tel: " + number.getMsisdn());
    System.out.println("Cost: " + number.getCost());
}

全文を見る

コードを実行する

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

以下のgradle コマンドを実行し、com.vonage.quickstart.numbers をSearchNumbers を含むパッケージに置き換えてアプリケーションを実行する：

gradle run -Pmain=com.vonage.quickstart.numbers.SearchNumbers

前提条件

Install-Package Vonage

SearchNumbers.cs という名前のファイルを作成し、以下のコードを追加する：

using Vonage.Numbers;
using Vonage.Request;
using Vonage;

全文を見る

SearchNumbers.cs に以下を追加する：


var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

全文を見る

コードを書く

SearchNumbers.cs に以下を追加する：


var request = new NumberSearchRequest()
{
    Country = countryCode,
    Type = vonageNumberType,
    Features = vonageNumberFeatures,
    Pattern = numberSearchCriteria,
    SearchPattern = numberSearchPattern
};

全文を見る

前提条件

composer require vonage/client

search-available.php という名前のファイルを作成し、以下のコードを追加する：

use Vonage\Numbers\Filter\AvailableNumbers;
use Vonage\Entity\IterableAPICollection;

全文を見る

search-available.php に以下を追加する：

$basic = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);

全文を見る

コードを書く

search-available.php に以下を追加する：

/** @var IterableAPICollection $response */
$filter = new AvailableNumbers([
    "pattern" => (string) NUMBER_SEARCH_CRITERIA,
    "search_pattern" => (int) NUMBER_SEARCH_PATTERN,
    "type" => VONAGE_NUMBER_TYPE,
    "features" => VONAGE_NUMBER_FEATURES,
]);
$response = $client->numbers()->searchAvailable(COUNTRY_CODE, $filter);

echo "There are " . count($response) . " matching numbers available for purchase:\n";

foreach ($response as $number) {
    echo "Tel: " . $number->getMsisdn() . " Cost: " . $number->getCost() . "\n";
}

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

php search-available.php

前提条件

pip install vonage python-dotenv

コードを書く

search.py に以下を追加する：

from vonage import Auth, Vonage
from vonage_numbers import SearchAvailableNumbersFilter

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

numbers, count, next = client.numbers.search_available_numbers(
    SearchAvailableNumbersFilter(
        country=NUMBER_COUNTRY_CODE,
        size=3,
        pattern=NUMBER_SEARCH_CRITERIA,
        search_pattern=NUMBER_SEARCH_PATTERN,
        type=NUMBER_TYPE,
        features=NUMBER_FEATURES,
    )
)
pprint(numbers)
print(count)
print(next)

for number in numbers:
    print(f'Tel: {number.msisdn} Cost: {number.cost}')

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

python numbers/search.py

前提条件

gem install vonage

search.rb という名前のファイルを作成し、以下のコードを追加する：

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

全文を見る

コードを書く

search.rb に以下を追加する：

response = client.numbers.search(
  country: COUNTRY_CODE,
  msisdn: VONAGE_NUMBER,
  type: VONAGE_NUMBER_TYPE,
  features: VONAGE_NUMBER_FEATURES,
  pattern: NUMBER_SEARCH_CRITERIA,
  search_pattern: NUMBER_SEARCH_PATTERN
)

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

ruby search.rb

参照

APIリファレンス