Check the Existence of PBX URL for P-Series Cloud Edition

Check if the PBX URL of a P-Series Cloud Edition already exists.

Request URL

GET {base_url}/product/openapi/instance/v1/paug_pbx_url_existed?{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
pbxUrl Yes String PBX URL of P-Series Cloud Edition.

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 Boolean Whether the PBX URL already exists.
  • true: The PBX URL already exists.
  • false: The PBX URL does not exist.
status Integer The HTTP status code of the API request.

Example

Request example

Check whether the PBX URL example.test.yeastar.com already exists.

GET /product/openapi/instance/v1/paug_pbx_url_existed?pbxUrl=example.test.yeastar.com HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTEzNjQ0ODkwODMyODk2XCIsXCJ1c2VyQ29kZVwiOlwiRGlzdHJpYnV0b3JcIixcInVzZXJJZFwiOlwiMzA3NjkxMzY0NDkxNTk5ODcyMFwiLFwidXNlcm5hbWVcIjpcImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbVwifSIsInVzZXJfbmFtZSI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3MzkyODEzMTYsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoiZ29FQ3BpSkMzMXlOQ2tkcktQSWVvaFE1dEtZPSIsImF1dGhvcml0aWVzIjpbIjc3Il0sImNsaWVudF9pZCI6ImFjMGYyZTViZWU3NmI2ZDdmNDU0NTY5NmMyNGZjMWYzIn0.O2ubDUQIqZsMguPt9adKWD-pwCvS_2e5VMMTWIQCO4c

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "a1b75c1bec8fc8eaa4284ee4cc2cc79a",
    "result": false,              // The PBX URL does not exist.
    "status": 200
}