查询单个响铃组的信息

查询单个响铃组的详细信息。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id 是 Integer 响铃组的唯一 ID。
注： 可使用 搜索特定响铃组 接口查询响铃组的 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object <Ring_Group_Detail> 响铃组的详细信息。
Ring_Group_Detail
参数 类型 说明
id Integer 响铃组的唯一 ID。
number String 响铃组号码。
name String 响铃组名称。
ring_strategy String 响铃组的响铃策略。
  • ring_all：响铃组中所有可用的分机同时响铃。
  • sequentially：响铃组中可用的分机按顺序响铃。
  • memory_hunt：先响铃响铃组中的第一个可用分机。如果在响铃期间没有应答，则继续响铃下一个可用分机，直到列表中的所有可用分机都响铃完毕。
  • custom：根据分机各自的延迟响铃时间进行响铃，并在各自的响铃超时时间后结束响铃。
ring_timeout Integer

在响铃下一个成员或将来电路由到无人接听目的地之前的等待时间 (秒)。

注： 该参数仅在 ring_strategy 的值为 ring_all、sequentially、memory_hunt 时有效。
member_list Array <Ring_Group_Member> 每个响铃组成员的信息。
fail_dest String

响铃组来电超时未接听时的目的地类型。

  • end_call：挂断。
  • extension：分机。
  • ext_vm：分机语音信箱。
  • group_vm：群语音信箱。
  • ivr：IVR。
  • call_flow：通话流程
  • ring_group：响铃组。
  • queue：队列。
  • external_num：外部号码。
  • play_greeting：播放提示音后退出。
fail_dest_prefix String

响铃组来电超时未接听时的目的地前缀。

注： 该参数的定义取决于 fail_dest 的取值。
  • 如果 fail_dest 为 external_num，该参数表示外部号码的呼出前缀。
  • 如果 fail_dest 为 play_greeting，该参数表示提示音的播放次数。
fail_dest_value String

响铃组来电超时未接听时的详细目的地。

注： 该参数的定义取决于 fail_dest 的取值。
  • 如果 fail_dest 为 play_greeting，该参数表示自定义提示音的文件名。
  • 如果 fail_dest 为 extension、ext_vm、group_vm、ivr、call_flow、ring_group 或 queue，该参数表示目的地的 ID。
  • 如果 fail_dest 为 external_num，该参数表示外部号码。
alert_info String

添加到 INVITE 请求的 Alert-Info 头域中的关键字，用于决定播放哪个铃声以识别响铃组来电。
welcome_prompt String 自定义提示音的文件名或等待音乐播放列表的名称。在成员接听来电之前，系统会向呼叫者播放对应音频。
moh String 等待音乐播放列表的名称。当通话被保持时，系统会向呼叫者播放该列表中的音频。
join_prompt String 自定义提示音的文件名。当呼叫进入响铃组时，系统会向呼叫者播放该提示音且仅播放一次。
play_full_join_prompt Integer 系统是否播完欢迎提示音后再响铃成员。
  • 0：禁用 - 系统按照配置响铃成员，与欢迎提示音是否完成播放无关。
  • 1：启用 - 系统播完欢迎提示音后再响铃成员。
client_unique_ringtone String 成员的 Linkus 客户端的铃声文件名。
no_agent_online_dest String

响铃组来电时无在线分机的目的地类型。

  • end_call：挂断。
  • extension：分机。
  • ext_vm：分机语音信箱。
  • group_vm：群语音信箱。
  • ivr：IVR。
  • call_flow：通话流程
  • ring_group：响铃组。
  • queue：队列。
  • external_num：外部号码。
  • play_greeting：播放提示音后退出。
no_agent_online_prefix String

响铃组来电时无在线分机的目的地前缀。

注： 该参数的定义取决于 no_agent_online_dest 的取值。
  • 如果 no_agent_online_dest 为 external_num，该参数表示外部号码的呼出前缀。
  • 如果 no_agent_online_dest 为 play_greeting，该参数表示提示音的播放次数。
no_agent_online_value String

响铃组来电时无在线分机的详细目的地。

注： 该参数的定义取决于 no_agent_online_dest 的取值。
  • 如果 no_agent_online_dest 为 play_greeting，该参数表示自定义提示音的文件名。
  • 如果 no_agent_online_dest 为 extension、ext_vm、group_vm、ivr、call_flow、ring_group 或 queue，该参数表示目的地的 ID。
  • 如果 no_agent_online_dest 为 external_num，该参数表示外部号码。
enb_miss_call Integer 是否将响铃组未接来电记录到来电超时未接听的目的地包括的分机的通话记录中。
  • 0：禁用 - 不记录未接来电。
  • 1：启用 - 记录未接来电。
注： 该参数仅在 ring_strategy 的值为 ring_all、memory_hunt 或 custom，且 fail_dest 的值为 extension、ring_group 或 queue 时可供参考。

Ring_Group_Member

参数 类型 说明
value String 响铃组成员的 ID。
注： 该参数仅在 ring_strategy 的值为 ring_all、sequentially、memory_hunt 时有效。
type String 响铃组成员的类型。
  • extension：分机。
  • ext_group：分机组。
注： 该参数仅在 ring_strategy 的值为 ring_all、sequentially、memory_hunt 时有效。
text String 响铃组成员的名称。
注： 该参数仅在 ring_strategy 的值为 ring_all、sequentially、memory_hunt 时有效。
text2 String 该参数的定义取决于 type 的取值。
  • 如果 type 为 extension，该参数表示分机号码。
  • 如果 type 为 ext_group，该参数表示分机组的名称。
注： 该参数仅在 ring_strategy 的值为 ring_all、sequentially、memory_hunt 时有效。
sub_option Array <Custom_Strategy_Member> 响铃组成员条目中包含的分机和分机组。
注： 该参数仅在 ring_strategy 的值为 custom 时有效。
delay_time Integer 在响铃响铃组成员条目中包含的所有分机前的延迟时间 (秒)。
注： 该参数仅在 ring_strategy 的值为 custom 时有效。
timeout Integer 在响铃下一个成员或将来电路由到无人接听目的地之前的等待时间 (秒)。
注： 该参数仅在 ring_strategy 的值为 custom 时有效。

Custom_Strategy_Member

参数 类型 说明
value String 响铃组成员的 ID。
type String 响铃组成员的类型。
  • extension：分机。
  • ext_group：分机组。
text String 响铃组成员的名称。
text2 String 该参数的定义取决于 type 的取值。
  • 如果 type 为 extension，该参数表示分机号码。
  • 如果 type 为 ext_group，该参数表示分机组的名称。

示例

请求示例

查询指定响铃组 (ID：8023) 的详细信息。

GET /openapi/v1.0/ringgroup/get?access_token=mlF8b3omcSD822Sosdc6kyiFkdYkC8UG&id=8023 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
响应示例
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
    }
}