Query Software PBX White Label Templates

Query the list of white label templates created on Yeastar Central Management.

Request URL

GET {base_url}/product/openapi/instance/v1/list/white_label?{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
partnerId No Integer Specify the unique ID of your subordinate customer to query the software PBX white label templates for that user.
Note: You can query user ID using the Query Subordinate User List interface.

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<WL_Info> The information of the white label templates.
status Integer The HTTP status code of the API request.
WL_Info
Parameter Type Description
whiteLabelId String The ID of the white label template.
whiteLabelName String The name of the white label template.

Example

Request example

Query the Software PBX white label templates created by a customer (partner ID: 3505184805912670208).

GET /product/openapi/instance/v1/list/white_label?partnerId=3505184805912670208 HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer ******

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "c41fdcda0a87c717b3f4ae60a69fa15d",
    "result": [
        {
            "whiteLabelId": "17757",
            "whiteLabelName": "My-custom-brand2"
        },
        {
            "whiteLabelId": "1450",
            "whiteLabelName": "My-custom-brand1"
        },
        {
            "whiteLabelId": "1311",
            "whiteLabelName": "IPPBX"
        }
    ],
    "status": 200
}