Query Global Ring Group Settings

Query the global ring group settings.

Request URL

GET {base_url}/{api_path}/ringgroup/getoptions?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to query the global ring group settings.

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.
data Array <Global_Settings> Global ring group settings.
Global_Settings
Parameter Type Description
enb_transfer_to_voicemail Integer Whether the extensions in the member list with their extension voicemail enabled are allowed to forward incoming ring group calls to their own extension voicemail directly from the incoming call window.
  • 0: Disallowed.
  • 1: Allowed.

Examples

Request example

GET /openapi/v1.0/ringgroup/getoptions?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "enb_transfer_to_voicemail": 0
    }
}