Get started using Postman Collections for Plivo Voice APIs

    Overview

    Plivo APIs are packaged and ready to use with Postman, an API testing tool that helps developers set up, test, and explore APIs. Plivo’s Postman collection includes APIs for our SMS, Voice, Phone Numbers, Account, Lookup, and PHLO products, along with documentation for each API to help you learn about them.

    We’ve created a ready-to-use set of the applicable APIs so you don’t have to manually add endpoints that you’d like to use inside Postman. Each endpoint comprises all the available parameters and the necessary authentication process, along with example responses, so you only need to declare your credentials and parameter values globally to start exploring the features. Let’s walk through the process.

    Install Postman and download the Postman collection

    First, download and install Postman. You also need a Plivo account; if you don’t have one yet, sign up now. Next, click on the below button

    A window will appear asking if you want the collection to be added to your local Postman app or if you want to use a web app.

    You’ll see the collection in your chosen space based on the options you’ve chosen.

    Add Keys and Tokens

    Now you can add your keys and tokens to your Postman collection. Open Postman from Applications under macOS or your desktop on Windows. The first thing you need to do is add your authentication credentials.

    • Click on the collection Plivo REST API.

    Edit Details

    • Select Authorization, then, from the drop-down list, set the Type as Basic Auth.

    Set Authorization

    • For Username and Password, fill in your Plivo Auth ID and Auth Token respectively, which you can find on the overview page of the console.

    You’ve now authenticated Postman to your Plivo account. The next step is to make that authentication available for every endpoint.

    Set up environment variables

    Set up the auth_id as an environment variable, so you can use it in every endpoint you have.

    • Click on the collection Plivo REST API.

      Edit Details

    • Click on Variables. Declare the variable auth_id, and provide the initial and current value as the Auth ID from the console.

      Set Variables

    • Once you’ve done that, you can access your Auth ID by writing {{auth_id}} within your Postman collection. We’ve already done that for you for all the APIs in the Plivo collection.

    Now we’re ready to test some APIs!!

    Example: Make a Phone Call

    To see how Plivo and Postman work together, let’s start by making an outbound call. From the imported Plivo REST API collection, select the folder named Call and select the request to make an outbound call. Replace from with your caller_id, to with the destination number you’d like to make a call & answer_url with a valid publicly accessible URL that returns a valid XML. These are the only mandatory parameters.

    Make a Phone Call

    Note:
  • The answer_url updated in the collection returns a valid XML which means you just need to update the from & to field to test the API.
  • You can replace the other optional parameters with meaningful values for your use case, or you can leave them out if you’re not using them in the request. As the values updated are dummy and can cause errors.
  • To learn more about optional and required parameters, either refer to the documentation available within the Postman collection or visit our Voice API reference guide.

    Document

    You can also find an example API response and status code for each API directly beneath the API tab, as in this example:

    Successful example

    Postman helps us keep all of our APIs organized, categorized, and always ready to use with just a few modifications depending on our needs. It helps us not only with triggering API requests but also with testing APIs. Overall, Postman makes it easier for developers to test and integrate their systems with Plivo.