Edit Global Ring Group Settings

Change the global settings for ring groups.

Request URL

POST {base_url}/{api_path}/ringgroup/updateoptions?access_token={access_token}

Request parameters

Parameter Required Type Description
enb_transfer_to_voicemail Yes Integer Whether to allow the extensions in the member list with their extension voicemail enabled to forward incoming ring group calls to their own extension voicemail directly from the incoming call window.

Valid value:

  • 0: Disallow.
  • 1: Allow.

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.

Examples

Request example

POST /openapi/v1.0/ringgroup/updateoptions?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
     "enb_transfer_to_voicemail":1
}

Response example

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