Query Password of an Extension

Query the registration password and voicemail access PIN of an extension.

Request URL

GET {base_url}/{api_path}/extension/getpassword?access_token={access_token}

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of an extension.
Note: You can query extension's ID using Search Specific Extensions.
type Yes String Password type.
Valid value:
  • reg_password: Registration password.
  • vm_pin: Voicemail access PIN.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
password String Registration password or voicemail access PIN.
Note: You can use a Base64 decoding tool to convert the password back to its original form.

Examples

Query the registration password of extension (ID: 80).

Request example

GET /openapi/v1.0/extension/getpassword?access_token=fJ71SE6TCRLAGUyv2J4YQco3jeqE1H47&id=80&type=reg_password HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "password": "SGM2bUFyVzYyTQ=="
}