Messages API 技術的詳細

Messages APIを使用すると、SMS、MMS、RCS、Facebook Messenger、Viber、WhatsAppでメッセージを送信したり、場合によっては受信したりできます。将来的にはさらに多くのチャンネルがサポートされる可能性があります。

下図は、Vonage Messages APIを使用することで、単一のエンドポイントから複数のチャネルを経由してご希望のユースケースのメッセージを送信する方法を示しています。例えば、WhatsAppとSMS経由で通知メッセージを送信することができます：

対応機能

限定的なサポート カスタムオブジェクト:

鍵だ：

• = 支持される。
• = チャンネルによってサポートされているが、Vonageではサポートされていない。
• n/a = チャネルがサポートしていない。

注釈

1. RCSでは custom タイプは非推奨です。ButtonとLocationメッセージは 提案チップス で text, cardそして carousel タイプメッセージ

認証

Messages API は以下をサポートしています。 いずれも 基本認証 または JWT（JSON Web Token）認証だが、この2つには注意すべき重要な違いがある：

• ベーシック認証では、エンコードされた APIキーとシークレットで認証する。 アカウント レベルだ。
• JWT認証では JSONウェブトークン 秘密鍵とアプリケーションIDを使用して生成される。JWTはACLのような高度な機能をサポートし、アプリケーションIDで認証する。 アプリケーション レベル、つまりVonageアプリケーションのアプリケーション設定などにアクセスできます。 ウェブフック そして セキュアなインバウンドメディア.

を使用することをお勧めします。 JWT認証 を使用します。Messages Sandboxを使用する場合など、APIを試してみる場合や、基本的な使用例(webhookが不要な場合など)では、Basic認証で十分かもしれません。

をご利用の場合 サーバーSDK を使用して Messages API とやり取りする場合、これらの API は自動的に JWT を作成します。

料金制限

Messages APIへのリクエストに対するデフォルトのレート制限は、APIキー1つにつき毎秒75リクエストです。この制限はケースバイケースで増やすことができます。レートリミットの引き上げについては、Account Managerまたは営業担当者にご相談ください。

外部アカウントAPI

について 外部アカウントAPI は、Viber Business Messages、Facebook Messenger、WhatsAppのアカウントを管理するために使用され、これらのチャンネルでMessages APIとDispatch APIを使用します。

スタート

この例では、以下の変数を便利な方法で実際の値に置き換える必要がある：

以下のコードは、Messages APIを使ってSMSメッセージを送信する方法を示しています：

curl -X POST https://api.nexmo.com/v1/messages \
	-u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
	-H 'Content-Type: application/json' \
	-H 'Accept: application/json' \
	-d $'{
		"to": "'${MESSAGES_TO_NUMBER}'",
		"from": "'${SMS_SENDER_ID}'",
		"channel": "sms",
		"message_type": "text",
		"text": "This is an SMS sent using the Vonage Messages API."
	}'

npm install @vonage/server-sdk @vonage/messages

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

/**
 * By leaving out the applicationId and privateKey parameters, the Vonage
 * SDK will use basic authentication to authenticate with the Messages API.
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    apiKey: VONAGE_API_KEY,
    apiSecret: VONAGE_API_SECRET,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

vonage.messages.send({
  messageType: 'sms',
  channel: Channels.SMS,
  text: 'This is an SMS text message sent using the Messages API',
  to: MESSAGES_TO_NUMBER,
  from: SMS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

参考

• Messages API リファレンス
• 外部アカウント API リファレンス