Query Product Model

Query product model of P-Series Appliance Edition or S-Series VoIP PBX.

Request URL

GET {base_url}/product/openapi/instance/v1/product_model?{query parameters}

Request parameters

Headers
Parameter Required Description
User-Agent Yes Provide information about the user agent, such as the type of web browser, operating system, software version, etc., so as to help Yeastar Partner Portal to identify the user or the application that is making the request.

Example: User-Agent: OpenAPI.
Authorization Yes Pass the access token in the header, so as to authenticate the API request.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
productId Yes Integer The unique ID of the product.
Note: You can query product ID using the Query Available Subscription Products interface.
productNo Yes String The Serial Number (SN) of P-Series Appliance Edition or S-Series VoIP PBX.

Response parameters

Parameter Type Description
code String The response message of the API request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
requestId String The unique ID of the request, which can be used to quickly locate the request.
result Object<Product_Model> Product model.
status Integer The HTTP status code of the API request.
Product_Model
Parameter Type Description
productModel String Product model.

Example

Request example

Query product model of P-Series Appliance Edition (SN: 3631E3418911).

GET /product/openapi/instance/v1/product_model?productNo=3631E3418911&productId=11 HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTE1NDU0NDY4NzY3NzQ0XCIsXCJ1c2VyQ29kZVwiOlwiUGFydG5lclwiLFwidXNlcklkXCI6XCIzMDc2OTE1NDU0NDg5NzM5MjY0XCIsXCJ1c2VybmFtZVwiOlwicGFydG5lcmV4YW1wbGVAb3V0bG9vay5jb21cIn0iLCJ1c2VyX25hbWUiOiJwYXJ0bmVyZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk2MTk4MjEsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwiYXV0aG9yaXRpZXMiOlsiNzkiXSwianRpIjoiZldUR0lTU3g1VzRobi8vZSthM3IvRC9tL05BPSIsImNsaWVudF9pZCI6IjE0NDI5NjM2ODBiMjM0YjA0YmRjZDVjMTZmODcyOWQ2In0.Ve8eXqvNj5QoZkinLQMy5I26X4dYqil1lpCZURJ17yA

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "f8917fe7891358352895caa50d0981c6",
    "result": {
        "productModel": "P550"
    },
    "status": 200
}