Query Passwordless Login URL of a Cloud PBX

Retrieve a passwordless login URL for a specified Cloud PBX instance.

Request URL

GET {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/password_free_login_url

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
data Object<Passwordless_Login_URL> The passwordless login URL.
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.
Passwordless_Login_URL
Parameter Type Description
passwordFreeLoginUrl String The passwordless login URL.

Example

Request example

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

Response example

HTTP/1.1 200 OK
{
    "data": {
        "passwordFreeLoginUrl": "https://demo.ptest3.cloud.com/freelogin?logincode=uWBBsLKy5nbsGMTBtOVqbgnthFkl6NHUiIgz4GdeIqtczRaJZ7rhnlShsp6EthhT&ys_id=17896360390850257349"
    },
    "requestId": "c3453f6e9c2509e3b5ecab50834860f2",
    "status": "Success",
    "time": 1793609357
}