Send a Request to Yeastar P-Series PBX System API with Postman

This topic introduces how to send a request to Yeastar P-Series PBX System API using Postman.

Prerequisites

Procedure

  1. Sign in to Postman.
  2. At the top-left corner of the workbench, click to open a new request tab.

  3. Compose and send an API request.
    Illustration Instruction
    Figure 1. Example 1 – POST request: Get an Access Token
    		 This example demonstrates how to send a POST request to obtain an access token, which is mandatory for the subsequent API requests.

    1. In the request method drop-down list, select POST.

    2. In the request field, enter the request URL of the API interface.

      In this example, enter the request URL of Get Access Token.

    3. Click Body > raw, and enter the request parameters of the API interface.
    4. Click Send.

      The response is displayed at the bottom of the workbench. In this example, an access token and a refresh token are returned.
    Figure 2. Example 2 – GET request: Query Extension List

    		 This example demonstrates how to send a GET request to obtain the extension list information.
    1. In the request method drop-down list, select GET.
    2. In the request field, enter the request URL of the API interface.

      In this example, enter the request URL of Query Extension List.

    3. In the Params tab, enter the request parameters of the API interface.
    4. Click Send.

      The response is displayed at the bottom of the workbench. In this example, the extension list is returned.

What to do next

Save the API requests to a collection, so as to better organize and manage the API requests.