https://d226lax1qjow5r.cloudfront.net/blog/blogposts/the-vonage-messages-api-is-now-in-our-server-sdks/sdk_updates.png

Vonage Messages APIが弊社のサーバーSDKに追加されました。

最終更新日 July 5, 2022

所要時間:1 分

更新Vonage Messages APIは以下をサポートするようになりました。 RCS (リッチコミュニケーションサービス)をサポートするようになりました!RCSは、返信の提案、リッチカード、リードレシート、ブランドコンテンツなどの機能を備えたリッチでインタラクティブなメッセージングを可能にします。RCSメッセージの詳細については ドキュメントをご覧ください。RCSビジネスメッセージングがVonage Messages APIでGAになりました" をご覧ください。

Vonageの メッセージAPIは、以下のような複数のチャネルにまたがるアプリケーションにメッセージング機能を統合する能力を開発者に提供します。 SMS, MMS, WhatsApp, フェイスブックメッセンジャーそして バイバー.

しかしこれまでは、Messages APIを使いたければエンドポイントに直接アクセスする必要があった。これは、Request/Responseサイクルの管理、ヘッダーの作成、認証の処理、データのシリアライズなど、様々な低レベルの問題に対処することを意味する。

この度 サーバーSDKがMessages APIをサポートしました。ですから、もしあなたが Ruby, ノード, PHP, Python, Javaまたは .NETSDKに低レベルの処理を任せて、アプリケーションの構築に専念することができます!

SDK経由でMessages APIを使ってできることのいくつかを見てみましょう。

SMS

Messages APIでできることのひとつに、SMSメッセージの送信があります。サーバーSDKを使ってSMSメッセージを送信したことがあるかもしれません。 SMS APIを使ってSMSメッセージを送信したことがあるかもしれません。.SMS APIまたはMessages APIのいずれかを使用して、SMSメッセージを送信することができます。

2つのAPIにはいくつかの違いがあります。例えば、認証オプションやウェブフックのセットアップなどです。また、これらの異なるAPIが私たちのサーバーSDKでどのように実装されているかという点でも違いがあります。

以下は、Messages APIを使ってSMSを送信する例です。 Ruby SDKおよび ノードSDK.

ルビーSDK

# instantiating a client object
client = Vonage::Client.new(
  application_id: '76543a12-1b87-4c32-a1b2-1d9876543210',
  private_key: File.read('private.key')
)

# creating an SMS message object
message = Vonage::Messaging::Message.sms(
  message: "A SMS message sent using the Vonage Messages API"
)

# sending the SMS
response = client.messaging.send(
  from: '447700900000',
  to: '447700900001',
  **message
)

ノードSDK

// initializing dependencies
const Vonage = require('@vonage/server-sdk')
const SMS = require('@vonage/server-sdk/lib/Messages/SMS');
const fs = require('fs');

// reads the private key file
let privateKey = fs.readFileSync('private.key', 'utf8');

// instantiating a client object
const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
  applicationId: '76543a12-1b87-4c32-a1b2-1d9876543210',
  privateKey: privateKey
})

// sending the SMS
vonage.messages.send(
  new SMS("This is an SMS text message sent using the Messages API", '447700900001', '447700900000'),
  (err, data) => {
    if (err) {
      console.error(err);
    } else {
      console.log(data.message_uuid);
    }
  }
);

MMS

SDKで利用可能になったもう1つのMessages APIチャネルは、MMS(Multimedia Message Service)です。このチャネルでは、画像、音声、Video、vCards (.vcfファイル)を含むメッセージを送信できます。

を使用してMMS画像メッセージを送信する例を示します。 .NET SDK.

var credentials = Credentials.FromApiKeyAndSecret(
  "76543a12-1b87-4c32-a1b2-1d9876543210",
  "abc123"
);

var vonageClient = new VonageClient(credentials);

var request = new Vonage.Messages.Mms.MmsImageRequest
{
    To = "447700900000",
    From = "447700900001",
    Image = new Attachment
    {
        Url = "https://example.com/image.jpg"
    }
};

var response = await vonageClient.MessagesClient.SendAsync(request);

WhatsApp

WhatsAppは近年爆発的な人気を誇るメッセージングチャネルです。ビジネスシーンにおけるWhatsAppは取引メッセージに最適で、会話型の商取引にも適しています。Vonage Messages APIを使えば、WhatsAppビジネスアカウントを使ってWhatsAppメッセージを送受信できます。SDKにメッセージが追加されたことで、WhatsAppメッセージングフローをお客様のアプリケーションに組み込むことがより簡単になりました。

Messages API はテキスト、画像、音声、ビデオなど様々なタイプの WhatsApp メッセージに対応しています! WhatsApp メッセージングとWhatsAppビジネスアカウント設定の詳細はこちら.

以下はWhatsAppビデオメッセージの送信例です。 PHP SDK.

// creating a Keypair object using private key and app id
$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents('private.key'),
    '76543a12-1b87-4c32-a1b2-1d9876543210'
);

// instantiating a Client object using the Keypair
$client = new \Vonage\Client($keypair);


// instantiating a VideoObject message attachment
$videoObject = new \Vonage\Messages\MessageObjects\VideoObject(
    'https://example.com/video.mp4',
    'This is an video file'
);

// instantiating a WhatsAppVideo message which contains the VideoObject attachment
$whatsApp = new \Vonage\Messages\MessageType\WhatsApp\WhatsAppVideo(
    '447700900001',
    '447700900000',
    $videoObject
);

// sending the WhatsAppVideo message
$client->send($whatsApp);

フェイスブックメッセンジャー

WhatsAppと同様に、Messages APIではFacebook Messengerをビジネスシーンで使用し、FacebookユーザーとFacebookページ間の会話を可能にします。このチャネルにもテキスト、画像、音声、Video、ファイルなど複数のメッセージタイプがあります。

Messengerについての詳細はドキュメントをご覧ください。 Java SDKを使ってMessenger音声メッセージを送信する例をご覧ください。

var client = VonageClient.builder()
    .applicationId("76102c93-1d87-4a13-a1d5-1c9863095337")
    .privateKeyPath("/path/to/private.key")
    .build();

var message = MessengerAudioRequest.builder()
    .from("9876543210").to("0123456789")
    .url("https://example.com/audio.mp3")
    .build();

var response = client.getMessagesClient().sendMessage(message);

バイバー

Messages APIで利用できるもうひとつのメッセージング・チャンネルはViberだ。Viberは、テキストまたは画像メッセージを送信するために使用することができます。Viber の詳細については についての詳細は.

以下は、Python SDK を使用して Viber テキストメッセージを送信する方法の例です。 Python SDK.

# initializing dependencies
import vonage

# instantiating a Client object with app id and private key
client = vonage.Client(
    application_id='76543a12-1b87-4c32-a1b2-1d9876543210',
    private_key='private.key',
)

# sending a message using the Messages object's send_message method
client.messages.send_message(
    {
        'channel': 'viber_service',
        'message_type': 'text',
        'to': '447700900000',
        'from': '9876543210',
        'text': 'This is a Viber message from the Vonage Messages API'
    }
)

今すぐMessages APIを使い始めたいですか?無料の Vonageデベロッパーアカウントを作成し、お好みのプログラミング言語用のサーバSDKをインストールし、言語固有の コード例をお試しください!

シェア:

https://a.storyblok.com/f/270183/373x376/e8d3211236/karl-lingiah.png
Karl LingiahRuby開発者支援

KarlはVonageのDeveloper Advocateで、RubyサーバSDKのメンテナンスとコミュニティの開発者エクスペリエンスの向上に注力しています。彼は学ぶこと、ものを作ること、知識を共有すること、そして一般的にウェブ技術に関連することが大好きです。