メニュー

Expand
ページを評価:

Twilio Node ヘルパーライブラリー

twilio-node ヘルパーライブラリは Twilio APIに対するHTTPリクエストを、Node.js コードを使って書けるようにします。

This library is open-source, so if you find a feature missing or a bug, we encourage you to file an issue or contribute back to the twilio-node project.

Server-Side only, not Front-End

This library is intended for back-end applications running on Node.js. If you are building a front-end, client-side application with React, Angular, Vue, Svelte, or plain HTML/CSS/Javascript, then your application client should only use one of the Twilio JavaScript SDKs below.

  • JavaScript SDK

    TwilioのJavaScript SDKは、ブラウザー内でビデオ通話の作成、VoIP通話の発信、またはリアルタイム・チャットの実装するために使用されます。 必要なSDKではじめましょう。

  • Do not use this Node.js library in a front-end application. Doing so can expose your Twilio credentials to end-users as part of the bundled HTML/JavaScript sent to their browser.

    For general HTTP requests to the Twilio API, consider writing a Twilio Function and making an HTTP request to the Function from within your app's client-side code.

    If you want to see how to put this Node.js library together with the Twilio Client Javascript library for voice, check out the Browser Dialer with Node.js and Vue.js. You'll see how to secure your Twilio account credentials from your end-users. The example creates capability tokens with a Node.js endpoint. Not using Vue? That guide also has example code for React, Angular, and Ember, if you prefer any of those frameworks.

    インストール

    最も簡単に twilio-node をインストールするには、NPM からインストールします。プロジェクトディレクトリーから以下のコマンドを実行することで、ライブラリーをインストールできます。

    npm install twilio
    

    そして、あなたのスクリプトの中で、以下を付与します。

    const twilio = require('twilio');
    

    インストールをテストする

    このようにSMSメッセージ送信を試します

    const accountSid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // Your Account SID from www.twilio.com/console
    const authToken = 'your_auth_token'; // Your Auth Token from www.twilio.com/console
    
    const twilio = require('twilio');
    const client = new twilio(accountSid, authToken);
    
    client.messages
      .create({
        body: 'Hello from Node',
        to: '+12345678901', // Text this number
        from: '+12345678901', // From a valid Twilio number
      })
      .then((message) => console.log(message.sid));
    

    It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out How to Set Environment Variables for more information.

    Using This Library

    Authenticate Client

    const accountSid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
    const authToken = 'your_auth_token';
    const client = require('twilio')(accountSid, authToken);
    

    Create A New Record

    const accountSid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
    const authToken = 'your_auth_token';
    const client = require('twilio')(accountSid, authToken);
    
    client.calls
      .create({
        url: 'http://demo.twilio.com/docs/voice.xml',
        to: '+14155551212',
        from: '+15017250604',
      })
      .then(call => console.log(call.sid));
    

    Get Existing Record

    const accountSid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
    const authToken = 'your_auth_token';
    const client = require('twilio')(accountSid, authToken);
    
    client
      .calls('CA42ed11f93dc08b952027ffbc406d0868')
      .fetch()
      .then(call => console.log(call.to));
    

    Iterate Through Records

    const accountSid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
    const authToken = 'your_auth_token';
    const client = require('twilio')(accountSid, authToken);
    
    client.calls.each(call => console.log(call.direction));
    

    The library automatically handles paging for you. Collections, such as calls and messages, have list and each methods that page under the hood. With both list and each, you can specify the number of records you want to receive (limit) and the maximum size you want each page fetch to be (pageSize). The library will then handle the task for you.

    list eagerly fetches all records and returns them as a list, whereas each streams records and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the page method.

    For more information about these methods, view the auto-generated library docs.

    例外ハンドリング

    Twilio API が 4XX または 5XX の HTTPレスポンスを受け取ると、twilio-node ライブラリはその情報をコールバックの error パラメータの中に含めます。4XX エラーは、通常のAPIオペレーションとして取り扱われ(無効な宛先、該当番号にSMSを送信できない 等)これらは適切にハンドリングされます。

    追加ドキュメント

    Nodeヘルパーライブラリーのインストールが問題なく完了したら、最新版のライブラリーを使用しているREST APIドキュメント、および各Twilio製品のドキュメントがお役に立つでしょう。 またこちらで、自動生成された最新版のSDK用のドキュメントもご活用ください。

    バージョン2.xのSDKにアクセスする

    Node SDKのもっとも最近のバージョンは、以前のTwilioアプリケーションで使用されている可能性のあるNode SDKの前バージョンである2.xと互換性がありません。 旧バージョンは引き続き機能し、引き続きドキュメント全体にわたってサンプルコードをご利用いただけます。 NPMからこのバージョンのインストールが必要な場合、下記コマンドで行います。

    npm install twilio@2.1.1
    

    代替手段として、こちらからGitHub上の旧バージョンのSDKを直接ダウンロードすることができます。

    ページを評価:

    ヘルプが必要ですか?

    We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

    フィードバックくださりありがとうございます!

    We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

    Sending your feedback...
    🎉 Thank you for your feedback!
    Something went wrong. Please try again.

    Thanks for your feedback!

    Refer us and get $10 in 3 simple steps!

    ステップ1

    Get link

    Get a free personal referral link here

    ステップ2:

    Give $10

    Your user signs up and upgrade using link

    ステップ3

    Get $10

    1,250 free SMSes
    OR 1,000 free voice mins
    OR 12,000 chats
    OR more