フェイルオーバーでメッセージを送る

Vonage Messages API で送信されたメッセージが拒否された場合、その代わりにフェイルオーバー・メッセージを定義することができます。フェイルオーバーは、どのチャネルやメッセージ・タイプから他のチャネルやメッセージ・タイプへも行うことができますが、以下の例ではRCSからSMSへのフェイルオーバーを示しています。

例

各コード・スニペットで使用されているすべての変数の説明を以下に示します：

キー説明
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_PRIVATE_KEY_PATH

Private key path.

TO_NUMBER

The number you are sending the to in E.164 format. For example 447700900000.

RCS_SENDER_ID

The sender ID for the RCS message.

JWT

Used to authenticate your request. See Authentication for more information, including how to generate a JWT.

SMS_SENDER_ID

The alphanumeric string that represents the name or number of the organization sending the message.

MESSAGES_API_URL

There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was https://api.nexmo.com/v0.1/messages, the new one is https://api.nexmo.com/v1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages or https://messages-sandbox.nexmo.com/v1/messages, depending on which version you have set in the sandbox dashboard.

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

コードを書く

send-message-with-failover.sh に以下を追加する：

curl -X POST "${MESSAGES_API_URL}" \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${RCS_SENDER_ID}'",
    "channel": "rcs",
    "message_type": "text",
    "text": "This is an RCS text message sent via the Vonage Messages API",
    "failover": [
      {
        "to": "'${MESSAGES_TO_NUMBER}'",
        "from": "'${SMS_SENDER_ID}'",
        "channel": "sms",
        "message_type": "text",
        "text": "This is an SMS sent using the Vonage Messages API."
      }
    ]
  }'

全文を見る

コードを実行する

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

bash send-message-with-failover.sh

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

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

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

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

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

全文を見る

コードを書く

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

val messageId = client.messages.send(
    rcsText {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        text("This is an RCS text message sent using the Messages API")
        failover(
            smsText {
                to(MESSAGES_TO_NUMBER)
                from(SMS_SENDER_ID)
                text("This is an SMS sent using the Vonage Messages API.")
            }
        )
    }
)

全文を見る

コードを実行する

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

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

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

gradle run -Pmain=com.vonage.quickstart.kt.messages.SendMessageWithFailover

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

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

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

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

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

全文を見る

コードを書く

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

var response = client.getMessagesClient().sendMessage(
		RcsTextRequest.builder()
			.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.text("This is an RCS message sent via the Vonage Messages API")
			.failover(SmsTextRequest.builder()
					.from(SMS_SENDER_ID).to(MESSAGES_TO_NUMBER)
					.text("This is an SMS sent using the Vonage Messages API.")
					.build()
			)
			.build()
);
System.out.println(response);

全文を見る

コードを実行する

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

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

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

gradle run -Pmain=com.vonage.quickstart.messages.SendMessageWithFailover

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

Install-Package Vonage

コードを書く

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

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "This is an RCS text message sent via the Vonage Messages API",
    Failover = new List<IMessage>
    {
        new SmsRequest
        {
            To = MESSAGES_TO_NUMBER,
            From = SMS_SENDER_ID,
            Text = "This is an SMS text message sent via the Vonage Messages API"
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

全文を見る

前提条件

申込書をお持ちでない場合は、ひとつ作る 。ウェブフックの設定 もご確認ください。

gem install vonage

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

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

全文を見る

コードを書く

send-message-with-failover.rb に以下を追加する：

rcs_message = client.messaging.rcs(
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
  type: 'text',
  message: 'This is an RCS text message sent via the Vonage Messages API'
)

sms_message = client.messaging.sms(
    to: MESSAGES_TO_NUMBER,
    from: SMS_SENDER_ID,
    message: 'This is a failover SMS message in case the RCS message is rejected.'
  )

client.messaging.send(
  **rcs_message,
  failover: [sms_message]
)

全文を見る

コードを実行する

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

ruby send-message-with-failover.rb

試してみる

コードを実行すると、宛先番号にRCSメッセージが送信される。そのメッセージが拒否されると、代わりにSMSメッセージが送信される。