Tutorial: Subscribe to High Availability Service for P-Series Cloud PBX (PCE Instance) Using API

This tutorial introduces the request parameters and provides a request example to show you how to subscribe to High Availability service for P-Series Cloud PBX (PCE Instance) using API.

Before you begin: Understand the request parameters

Before subscribing to High Availability service for a P-Series Cloud PBX (PCE Instance) using API, we recommend that you read the table below to understand the request parameters and collect the corresponding values.


Item	Parameter	Description
Operation Type	`operationType`	The operation type. In this scenario, the value is fixed at `purchase_service`.
Product ID	`productId`	Specify the product for which you want to subscribe to High Availability service. The Product ID for P-Series Cloud PBX (PCE Instance) is `13`.
PBX Serial Number (SN)	`productNo`	Specify the device for which you want to subscribe to High Availability service. You will need to query the PBX SN as described in the following steps.
Billing Contact ID	`billingId`	Specify the contact who can receive the invoice after you subscribe to High Availability service. You will need to query the Billing Contact ID as described in the following steps.
Connection Plan ID	`connectionPlanId`	Specify the current subscription plan. You will need to query the Connection Plan ID as described in the following steps.
Service Type	`serviceType`	The service type. In this scenario, the value is fixed at `service`.
Service ID	`serviceId`	Specify the specific service to which you want to subscribe. You will need to query the Service ID as described in the following steps.
Quantity	`quantity`	Specify the current number of extensions. Note: High Availability service is charged based on extensions.
Purchase Type	`purchaseType`	The purchase type. In this scenario, the value is fixed at `purchase`.
Billing Model	`billingModel`	The billing model. In this scenario, the value is fixed at `recurring`.
Billing Model	`billingModel`	The billing model. In this scenario, the value is fixed at `recurring`.
Billing Cycle	`billingCycle`	The billing cycle. In this scenario, the value is fixed at `annually` or `monthly`.
Multi Cycle	`multiCycle`	The interval of recurring billing. In this scenario, the value is fixed at `0`.

Step 1. Get Serial Number (SN)

Make a request to the Query Product List API endpoint with the Product ID 13.
```
GET {base_url}/product/openapi/instance_product/v1/client/instance_product_list?productId=13
```
Note down the returned value of productNo for the desired P-Series Cloud PBX (PCE Instance).

Step 2. Get connection plan ID and service ID

Make a request to the Query Available Subscription / Trial Plans and Services for a Product API endpoint with the Product ID 13.
```
GET {base_url}/pricing/openapi/purchase/v1/purchase_product_info?productId=13
```
Note down the returned value of planId and serviceId for the desired plan and service.

Step 3. Get billing contact ID

Make a request to the Query Billing Contact List API endpoint.

GET {base_url}/user/openapi/user/v1/client/billing_contact_list

Note down the returned value of billingContactId for the desired billing contact.

Step 4. Subscribe to High Availability service for P-Series Cloud PBX (PCE Instance)

Make a request to the Create an Order API endpoint with the collected values.

POST {base_url}/order/openapi/order/v1/save

In this tutorial, the values we collect are shown below:


Item	Parameter	Value
Operation Type	`operationType`	purchase_service
Product ID	`productId`	13
PBX Serial Number (SN)	`productNo`	3658B4311196K2ID
Billing Contact ID	`billingId`	3197218168379846218
Connection Plan ID	`connectionPlanId`	3048571730026938368 (ID for Enterprise Plan)
Service Type	`serviceType`	service
Service ID	`serviceId`	3048573935752720384 (ID for High Availability service)
Quantity	`quantity`	10
Purchase Type	`purchaseType`	purchase
Billing Model	`billingModel`	recurring
Billing Cycle	`billingCycle`	annually
Multi Cycle	`multiCycle`	0

The sample request to subscribe to High Availability service for a P-Series Cloud PBX (PCE Instance) is shown below:

POST /order/openapi/order/v1/save HTTP/1.1
Host: openapi.partner.yeastar.com
Content-Type: application/json
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTE1NDU0NDY4NzY3NzQ0XCIsXCJ1c2VyQ29kZVwiOlwiUGFydG5lclwiLFwidXNlcklkXCI6XCIzMDc2OTE1NDU0NDg5NzM5MjY0XCIsXCJ1c2VybmFtZVwiOlwicGFydG5lcmV4YW1wbGVAb3V0bG9vay5jb21cIn0iLCJ1c2VyX25hbWUiOiJwYXJ0bmVyZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk3MTc5MjYsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoidmlzMkh0QkxaUStNQmxPbS9UdThWR1pyNFljPSIsImF1dGhvcml0aWVzIjpbIjc5Il0sImNsaWVudF9pZCI6IjE0NDI5NjM2ODBiMjM0YjA0YmRjZDVjMTZmODcyOWQ2In0.RPRoTJRkXCB4krDSwGRpUFyCfUVv2LHjIiBICA1pCiY

{
  "operationType": "purchase_service",
  "productId": 13,
  "productNo": "3658B4311196K2ID",
  "billingId": 3197218168379846218,
  "serviceList": [
    {
      "connectionPlanId":3048571730026938368,
      "serviceType": "service",
      "serviceId": 3048573935752720384,
      "quantity": 10,
      "purchaseType": "purchase",
      "billingModel": "recurring",
      "billingCycle": "annually",
      "multiCycle": 0
    }
  ]
}

Result

The sample response is shown below:

{
    "code": "success",
    "detailMessage": "",
    "requestId": "708129833842d0db94fa5f534e18eefc",
    "result": {
        "instanceId": "1280297",
        "orderNo": "YL3206252408495661056",
        "orderStatus": "succeed",
        "productNo": "3658B4311196K2ID",
        "transactionNo": "HX3206252409602957313"
    },
    "status": 200
}