Reset Administrator Password of a Cloud PBX

Trigger a password reset for the super administrator account of a specified Cloud PBX instance. An email containing password reset instructions will be sent to the administrator's email address.

Request URL

POST {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/reset_administrator_password

Request parameters

Path parameter


Parameter	Required	Type	Description
cloudPbxId	Yes	Integer	The ID of the Cloud PBX. Note: You can query the PBX ID using Query All the Cloud PBXs.

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	Pass the access token in the header. Format: Bearer `{access_token}`.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
status	String	Request result: `Success` `Failed`
time	Long	The response time. Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.

Example

Request example

POST /dm/open_api/v1/cloud_pbx/instances/389283/reset_administrator_password HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MjE0NTl9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTIzMjU5LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwYjA1YjEwNy0xOGQ5LTRlYWEtYTFhMS02YTRhZDAzZTgzMjciLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.mTwHgU5A3g1sOIA-KHJ39IYAZyC0Wf_OltBJENvzxgM

Response example

HTTP/1.1 200 OK
{
    "requestId": "e6f24051f0e00cfc1d5e5bff07b38fd9",
    "status": "Success",
    "time": 1793610105
}