シェア:
){kind=small}
元Vonage開発者エデュケーター。PHPのバックグラウンドを持つが、一つの言語に縛られることはない。熱心なゲーマーでRaspberry pi愛好家。屋内クライミング施設でボルダリングをしていることが多い。
USショートコードAPI廃止のテクニカルガイド
所要時間：3 分
アプリケーション・トゥ・パーソン（A2P）メッセージング業界に変化が起きている。Vonageは 米国共有ショートコードAPIT-MobileとAT&Tの新しい行動規範が、A2Pトラフィックの共有発信者のユーザーを調査するためです。この非推奨は、新しい A2P 10DLC規格と連動したもので、ロングコードの柔軟性を高め、企業によるショートコードの使用を制限するものです。
その結果、米国の通信事業者は共有ショートコード（SSC）のトラフィックをサポートしなくなります。専用ショートコードには影響しませんのでご注意ください。
VonageのUS Shared Short Code APIをご利用のお客様は、他の利用可能なAPIに移行する必要があります。SMS経由の通信にUS Shared Short Code APIを使用している場合、SMS APIを使用するためにコードと設定を調整する必要があります。 SMS API.さらに、二要素認証に使用している場合は、コードを調整して SMS APIまたは Verify API のどちらかを使うようにコードを調整する必要があります。.
VonageがサポートするSDKを使用したくない場合は、APIそのものをすぐにご利用いただけます。これらのAPIの詳細については SMS APIリファレンスおよび Verify APIリファレンス.
Vonageには様々な言語をサポートするライブラリがあります。 開発者ダッシュボード SMS 概要.しかし、このページではNode.jsを使用した例をいくつか紹介します。
SDKは以下のコマンドでインストールできる：
以下のコード・スニペットは、あらかじめ設定した電話番号にSMSを送信する方法の例です：
const Vonage = require('@vonage/server-sdk')
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
})
const from = VONAGE_BRAND_NAME
const to = TO_NUMBER
const text = 'A text message sent using the Vonage SMS API'
vonage.message.sendSms(from, to, text, (err, responseData) => {
if (err) {
console.log(err);
} else {
if(responseData.messages[0]['status'] === "0") {
console.log("Message sent successfully.");
} else {
console.log(`Message failed with error: ${responseData.messages[0]['error-text']}`);
}
}
})
SMSを受信するには、プロジェクトが一般にアクセス可能なWebhookを持っている必要があります。開発目的であれば、ngrokを使うことをお勧めします。 こちら.
まず、このプロジェクトには2つのサードパーティ・ライブラリexpressとbody-parserが必要で、以下のように実行すればインストールできる：
以下のコード・スニペットは、Webhookを使用して受信SMSを処理する方法の例を示しています： /webhooks/inbound-sms
const app = require('express')()
const bodyParser = require('body-parser')
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: true }))
app
.route('/webhooks/inbound-sms')
.get(handleInboundSms)
.post(handleInboundSms)
function handleInboundSms(request, response) {
const params = Object.assign(request.query, request.body)
console.log(params)
response.status(204).send()
}
app.listen(process.env.PORT || 3000)SMS APIには、ユーザーが連絡をオプトインまたはオプトアウトできる機能はありません。この変更により、開発者は上記の例を調整し、データベースなどにユーザーの連絡先設定を保存する方法を設定することで、開発者側でこの機能を処理する必要があります。
US Shared Short Codesの廃止に伴い、SMSメッセージの送受信には新しい番号を購入する必要があります。番号の購入は 開発者ダッシュボード.必ず SMS 機能のある番号をお選びください。
利用可能な 移行オプションをご覧ください。
US Shared Short Code APIには、アラート、マーケティング、2ファクタ認証など、異なるアラートタイプを使用するためのテンプレートを登録する機能がダッシュボードにありました。この機能は利用できなくなりましたので、プロジェクト内でこれらのテンプレートを作成する必要があります。
SMS APIの使用に関する詳細情報については、以下のページで必要なすべての情報をご覧いただけます。 開発者ダッシュボード.
SMS APIの価格に関する情報は、以下のページをご参照ください。 価格設定ページ.
Vonageには様々な言語をサポートするライブラリがあり、Developer Docs Verifyの概要で見ることができます。しかし、このページではNode.jsを使用した例をいくつか紹介します。
まず、このプロジェクトにはVonage Node SDKが必要です。 @vonage/server-sdkをインストールする必要があります：
以下のコード・スニペットは、ユーザーの検証を要求する方法の例である：
あなたのVonage APIキー
あなたのVonage APIシークレット
受信者番号
およびブランド名 / 背番号
const Vonage = require('@vonage/server-sdk');
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
});
vonage.verify.request({
number: RECIPIENT_NUMBER,
brand: BRAND_NAME
}, (err, result) => {
if (err) {
console.error(err);
} else {
const verifyRequestId = result.request_id;
console.log('request_id', verifyRequestId);
}
});
以下のコードでも、前のステップで見つけた例のVonageインスタンス化が必要です。しかし、ユーザーから入力された検証コードをチェックするために、以下のコード・スニペットはこの機能を示しています。
を必ず更新してください。 REQUEST_IDと CODEを有効な値で更新してください。
vonage.verify.check({
request_id: REQUEST_ID,
code: CODE
}, (err, result) => {
if (err) {
console.error(err);
} else {
console.log(result);
}
});
Verify APIは、デフォルトで不許可リストを管理する機能を提供しています。この機能は、STOPで返信するエンドユーザーに自動返信し、それらのエンドユーザーに以降のメッセージを受信しないようにフラグを立てる機能が組み込まれていることを意味します。
USSC APIを使用して2FAテンプレートを使用しているVonageのお客様であれば、Verify APIを使用してテンプレートをカスタマイズできる可能性があります。当社の Verifyドキュメントを参照してください。
US Shared Short Code APIには、アラート、マーケティング、2ファクタ認証など、異なるアラートタイプを使用するためのテンプレートを登録する機能がダッシュボードにありました。この機能は利用できなくなりましたので、プロジェクト内でこれらのテンプレートを作成する必要があります。
Verify API の使用に関する詳細については、必要なすべての情報を次のサイトでご覧いただけます。 開発者ダッシュボード.
Verify APIの価格に関する情報をお知りになりたい場合は、以下のページをご参照ください。 価格設定ページ.