Query Information of a Ring Group

Query the detailed information of a ring group.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of the ring group.
Note: You can query the ring group's ID using Search Specific Ring Groups.

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 Object <Ring_Group_Detail> The detailed information of the ring group.
Ring_Group_Detail
Parameter Type Description
id Integer The unique ID of the ring group.
number String The ring group number.
name String The ring group name.
ring_strategy String The ring strategy of the ring group.
  • ring_all: Ring all available extensions simultaneously.
  • sequentially: Ring all available extensions sequentially.
  • memory_hunt: Ring the first available extension in the member list. If no answer within the ring time, progressively ring the next available extension, until all the available extensions in the list rang.
  • custom: Ring extensions according to their individual ring delays and stop ringing after their individual ring timeouts.
ring_timeout Integer

The waiting time (in seconds) before ringing the next member or routing the call to Failover Destination.

Note: The parameter is valid only when the value of ring_strategy is ring_all, sequentially or memory_hunt.
member_list Array <Ring_Group_Member> The information of each member in the ring group.
fail_dest String

The destination type for ring group calls unanswered within ring timeout.

  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • group_vm: Group Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow
  • ring_group: Ring Group.
  • queue: Queue.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
fail_dest_prefix String

The destination prefix for ring group calls unanswered within ring timeout.

Note: The definition of this parameter depends on the value of fail_dest.
  • If fail_dest is external_num, this parameter indicates the dial-out prefix of the external number.
  • If fail_dest is play_greeting, this parameter indicates the play count of the prompt.
fail_dest_value String

The detailed destination for ring group calls unanswered within ring timeout.

Note: The definition of this parameter depends on the value of fail_dest.
  • If fail_dest is play_greeting, this parameter indicates the filename of custom prompt.
  • If fail_dest is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter indicates the destination ID.
  • If fail_dest is external_num, this parameter indicates the external number.
alert_info String

The keyword added to Alert-info header in INVITE request, determining which ringtone to be play to identify ring group calls.
welcome_prompt String The prompt or music played to callers before members answer the calls.
  • Empty string: Continue to play the previous stage's prompt; if no prompt exists, play the caller's own ring tone (beep sound).
  • Other value: The filename of custom prompt or the name of MoH (music on hold) playlist.
moh String The music played to callers when the calls are put on hold.
  • follow_system: Follow system setting (Set on PBX Settings > Voice Prompt > Prompt Preferences > Music on Hold).

  • Other value: The name of the MoH (Music on Hold) playlist.
join_prompt String The prompt played to callers only once when the calls join the ring group.
  • Empty string: Play the next stage's prompt; if no prompt exists, play the caller's own ringing tone (beep sound).
  • Other value: The filename of the custom prompt.
play_full_join_prompt Integer Whether the system plays full join prompt to callers before ringing members.
  • 0: Disable - The system rings members as configured regardless of whether the join prompt is fully played.
  • 1: Enable - The system rings members after playing full join prompt.
client_unique_ringtone String The ringtone for member's Linkus clients.
  • Empty string: The system will use the ringtone set on the Linkus clients.
  • Other value: The filename of the ringtone.
no_agent_online_dest String

The destination type for ring group calls with no online extensions.

  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • group_vm: Group Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow
  • ring_group: Ring Group.
  • queue: Queue.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
no_agent_online_prefix String

The destination prefix for ring group calls with no online extensions.

Note: The definition of this parameter depends on the value of no_agent_online_dest.
  • If no_agent_online_dest is external_num, this parameter indicates the dial-out prefix of the external number.
  • If no_agent_online_dest is play_greeting, this parameter indicates the play count of the prompt.
no_agent_online_value String

The detailed destination for ring group calls with no online extensions.

Note: The definition of this parameter depends on the value of no_agent_online_dest.
  • If no_agent_online_dest is play_greeting, this parameter indicates the filename of custom prompt.
  • If no_agent_online_dest is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter indicates the destination ID.
  • If no_agent_online_dest is external_num, this parameter indicates the external number.
enb_miss_call Integer Whether missed ring group calls are recorded in call logs of extensions included in failover destination.
  • 0: Disable - The missed calls are not recorded in call logs.
  • 1: Enable - The missed calls are recorded in call logs.
enable_time_condition Integer Whether time condition is enabled.
  • 0: Disabled.
  • 1: Enabled.
timezone_id Integer Time zone ID.
outoffice_dest String

The destination type for ring group calls outside business hours.

  • receive_call: Receive calls.
  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • group_vm: Group Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow.
  • ring_group: Ring Group.
  • queue: Queue.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
outoffice_dest_prefix String
The destination prefix for ring group calls outside business hours.
Note: This parameter returns value only when outoffice_dest is set to external_num or play_greeting.
  • When outoffice_dest is set to external_num, this parameter indicates the dialing prefix prepended before external number.
  • When outoffice_dest is set to play_greeting, this parameter indicates the number of times that the prompt will be played.
outoffice_dest_value String

The detailed destination for ring group calls outside business hours.

Note: The definition of this parameter depends on the value of outoffice_dest.
  • If outoffice_dest is play_greeting, this parameter indicates the filename of custom prompt.
  • If outoffice_dest is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter indicates the destination ID.
  • If outoffice_dest is external_num, this parameter indicates the external number.
holiday_dest String

The destination type for ring group calls during holidays.

  • receive_call: Receive calls.
  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • group_vm: Group Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow.
  • ring_group: Ring Group.
  • queue: Queue.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
holiday_dest_prefix String
The destination prefix for ring group calls during holidays.
Note: This parameter returns value only when holiday_dest is set to external_num or play_greeting.
  • When holiday_dest is set to external_num, this parameter indicates the dialing prefix prepended before external number.
  • When holiday_dest is set to play_greeting, this parameter indicates the number of times that the prompt will be played.
holiday_dest_value String

The detailed destination for ring group calls during holidays.

Note: The definition of this parameter depends on the value of holiday_dest.
  • If holiday_dest is play_greeting, this parameter indicates the filename of custom prompt.
  • If holiday_dest is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter indicates the destination ID.
  • If holiday_dest is external_num, this parameter indicates the external number.
ignore_holiday_dest Integer Whether ring group calls received during holidays are routed according to the business hours destination.
  • 0: Disabled.
  • 1: Enabled.
enb_play_holiday_prompt_global Integer Whether holiday prompt is played before ring group calls received during holidays are routed to the holiday destination.
  • 0: Disabled.
  • 1: Enabled.

Ring_Group_Member

Parameter Type Description
value String The ID of the ring group member.
Note: The parameter is valid only when the value of ring_strategy is ring_all, sequentially or memory_hunt.
type String The type of the ring group member.
  • extension: Extension.
  • ext_group: Extension group.
Note: The parameter is valid only when the value of ring_strategy is ring_all, sequentially or memory_hunt.
text String The name of the ring group member.
Note: The parameter is valid only when the value of ring_strategy is ring_all, sequentially or memory_hunt.
text2 String The definition of this parameter depends on the value of type.
  • If type is extension, the parameter indicates the extension number.
  • If type is ext_group, the parameter indicates the name of the extension group.
Note: The parameter is valid only when the value of ring_strategy is ring_all, sequentially or memory_hunt.
sub_option Array <Custom_Strategy_Member> The extensions and extension groups included in the ring group member entry.
Note: The parameter is valid only when the value of ring_strategy is custom.
delay_time Integer The time delay (in seconds) before ringing all extensions included in the ring group member entry.
Note: The parameter is valid only when the value of ring_strategy is custom.
timeout Integer The waiting time (in seconds) before ringing the next member or routing the call to Failover Destination.
Note: The parameter is valid only when the value of ring_strategy is custom.

Custom_Strategy_Member

Parameter Type Description
value String The ID of the ring group member.
type String The type of the ring group member.
  • extension: Extension.
  • ext_group: Extension group.
text String The name of the ring group member.
text2 String The definition of this parameter depends on the value of type.
  • If type is extension, the parameter indicates the extension number.
  • If type is ext_group, the parameter indicates the name of the extension group.

Examples

Request example

Query the detailed information of the specified ring group (ID: 8023).

GET /openapi/v1.0/ringgroup/get?access_token=mlF8b3omcSD822Sosdc6kyiFkdYkC8UG&id=8023 HTTP/1.1
Host: 192.168.5.150:8088
Response example
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 8023,
        "number": "6300",
        "name": "Technical Support",
        "ring_strategy": "ring_all",
        "ring_timeout": 20,
        "member_list": [
            {
                "value": "3071",
                "type": "extension",
                "text": "Evelyn",
                "text2": "3200",
                "delay_time": 0,
                "timeout": 0,
                "sub_option": null
            },
            {
                "value": "3074",
                "type": "extension",
                "text": "Dave Haris",
                "text2": "3202",
                "delay_time": 0,
                "timeout": 0,
                "sub_option": null
            },
            {
                "value": "3075",
                "type": "extension",
                "text": "Terrell Smith",
                "text2": "3021",
                "delay_time": 0,
                "timeout": 0,
                "sub_option": null
            }
        ],
        "fail_dest": "end_call",
        "fail_dest_prefix": "",
        "fail_dest_value": "",
        "alert_info": "ring-group-support",
        "welcome_prompt": "SoftBreeze",
        "moh": "SoftBreeze",
        "join_prompt": "DID.wav",
        "play_full_join_prompt": 1,
        "client_unique_ringtone": "",
        "no_agent_online_dest": "end_call",
        "no_agent_online_prefix": "",
        "no_agent_online_value": "",
        "enb_miss_call": 0,
        "enable_time_condition": 1,
        "timezone_id": 1,
        "outoffice_dest": "end_call",
        "outoffice_dest_prefix": "",
        "outoffice_dest_value": "",
        "holiday_dest": "end_call",
        "holiday_dest_prefix": "",
        "holiday_dest_value": "",
        "ignore_holiday_dest": 0,
        "enb_play_holiday_prompt_global": 0
    }
}