查询单个分机信息

查询单个分机的详细信息。

请求 URL

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

请求参数

表 1.
参数 是否必填 类型 说明
id 是 Integer 分机的唯一 ID。
注： 可使用 搜索特定分机 接口查询分机 ID。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object <Ext_DetailInfo> 分机的详细信息。
Ext_DetailInfo
参数 类型 说明
id Integer 分机的唯一 ID。
type String 分机类型。
  • SIP：SIP 分机
  • FXS：FXS 分机
fxs_port String FXS 端口。

例：如果分配给分机的 FXS 端口为 "Span1-Port5"，则此参数返回 1-5。
first_name String 名称。
last_name String 姓氏。
email_addr String 邮箱地址。
mobile_number String 手机号码。
organization_list Array <Organization_Info> 分机所属部门。
role_id Integer 分机用户角色的唯一 ID。
title String 分机用户的职位。
number String 分机号码。
caller_id String 显示号码。
reg_name String 认证名称。
reg_password String 注册密码。
concurrent_registrations Integer SIP 终端同时注册数。
  • 1
  • 2
  • 3
presence_status String 分机当前的在线状态。
  • available：空闲
  • away：离开
  • business_trip：出差
  • do_not_disturb：免打扰 (DND)
  • lunch：午休
  • off_work：下班
presence_list Array <Presence_Setting> 在线状态设置列表。
agent_id String

分机作为队列坐席接听来电后，系统向呼叫者播报的坐席工号。

默认播报分机号作为坐席的工号。
enb_vm Integer 是否启用了语音信箱。
  • 0：禁用
  • 1：启用
enb_vm_pin Integer 是否启用了语音信箱 PIN 码认证。
  • 0：禁用
  • 1：启用
vm_pin String 用于访问语音信箱的 PIN 码。
new_vm_notification String 收到新语音留言时是否通知分机，以及如何通知。
  • no：不发送电子邮件通知。
  • with_attach：发送电子邮件通知，并将新的语音留言转换成 .wav 格式的文件附在邮件中。
  • without_attach：发送电子邮件通知，但不附上语音留言文件。
vm_after_notification String 发送通知邮件后如何处理语音留言。
  • no：保留语音信箱中的新语音留言并标记为未读。
  • mark_read：保留语音信箱中的新语音留言并标记为已读。
  • delete：删除语音留言。
enb_all_reject_mode_for_endpoints Integer 在注册了分机的其中一个终端上拒接来电后，其他终端是否会停止响铃。
  • 0：禁用。在其中一个终端上拒接来电后，其他终端仍会响铃。
  • 1：启用。在其中一个终端上拒接来电后，其他终端停止响铃。
dtmf_mode String DTMF 模式。
  • rfc4733：RFC4733 (RFC2833)
  • info：Info
  • inband：Inband
  • auto：Auto
transport String 传输协议。
  • udp：UDP 协议
  • tcp：TCP 协议
  • tls：TLS 协议
enb_qualify Integer 是否启用了 Qualify 功能。
  • 0：禁用
  • 1：启用
enb_t38_support Integer 是否启用了 支持 T.38 功能。
  • 0：禁用
  • 1：启用
enb_nat Integer 是否启用了 NAT 功能。
  • 0：禁用
  • 1：启用
enb_srtp Integer 是否启用了 语音加密 (SRTP) 功能。
  • 0：禁用
  • 1：启用
allow_reg_remotely Integer 是否启用了 允许远程注册。
  • 0：禁用
  • 1：启用
disable_outb_call Integer 是否允许拨打外线电话。
  • 0：允许拨打外线电话。
  • 1：禁止拨打外线电话。
disable_outb_call_outside_business_hours Integer

是否允许非办公时间拨打外线电话。

  • 0：允许非办公时间拨打外线电话。
  • 1：禁止非办公时间拨打外线电话。
disable_international_call Integer 是否允许拨打国际电话。
  • 0：允许拨打国际电话。
  • 1：禁止拨打国际电话。
outbound_route_permission Array <Integer> 允许分机使用的呼出路由的唯一 ID。
enb_mobile_client Integer 是否启用了 Linkus 手机端。
  • 0：禁用
  • 1：启用
enb_web_client Integer 是否启用了 Linkus 网页端。
  • 0：禁用
  • 1：启用
enb_desktop_client Integer 是否启用了 Linkus 桌面端。
  • 0：禁用
  • 1：启用
enb_internal_client Integer 是否启用了 Linkus 通话功能。
注： 若启用，分机用户可以登录并使用 Linkus 手机端、桌面端和网页端。
  • 0：禁用
  • 1：启用
linkus_mobile_codec String Linkus 手机端编解码。
  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
enb_ice String 是否为 Linkus 手机端启用了 ICE (Interactive Connectivity Establishment, 交互式连接创建) 功能。
  • yes：ICE 启用。
  • no：ICE 禁用。
Organization_Info
表 3.
参数 类型 说明
text String 分机所属部门名称。
value String 所属部门的唯一 ID。
Presence_Setting
参数 类型 说明
status String 分机在线状态。
  • available：空闲
  • away：离开
  • business_trip：出差
  • do_not_disturb：免打扰 (DND)
  • lunch：午休
  • off_work：下班
enb_in_always_forward Integer 是否将所有内部来电都转移到指定目的地 (总是 前转)。
  • 0：禁用
  • 1：启用
in_always_forward_dest String 内部来电 总是 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
in_always_forward_prefix String 内部来电 总是 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
in_always_forward_value String 内部来电 总是 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
in_always_forward_num String 内部来电 总是 前转目的地 external_num 的外部号码。
enb_in_no_answer_forward Integer 是否在分机无应答时将内部来电转移到指定目的地 (无应答 前转)。
  • 0：禁用
  • 1：启用
in_no_answer_forward_dest String 内部来电 无应答 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
in_no_answer_forward_prefix String 内部来电 无应答 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
in_no_answer_forward_value String 内部来电 无应答 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
in_no_answer_forward_num String 内部来电 无应答 前转目的地 external_num 的外部号码。
enb_in_busy_forward Integer 是否在分机忙时将内部来电转移到指定目的地 (忙时 前转)。
  • 0：禁用
  • 1：启用
in_busy_forward_dest String 内部来电 忙时 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
in_busy_forward_prefix String 内部来电 忙时 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
in_busy_forward_value String 内部来电 忙时 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
in_busy_forward_num String 内部来电 忙时 前转目的地 external_num 的外部号码。
enb_ex_always_forward Integer 是否将所有外部来电都转移到指定目的地 (总是 前转)。
  • 0：禁用
  • 1：启用
ex_always_forward_dest String 外部来电 总是 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
ex_always_forward_prefix String 外部来电 总是 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
ex_always_forward_value String 外部来电 总是 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
ex_always_forward_num String 外部来电 总是 前转目的地 external_num 的外部号码。
enb_ex_no_answer_forward Integer 是否在分机无应答时将外部来电转移到指定目的地 (无应答 前转)。
  • 0：禁用
  • 1：启用
ex_no_answer_forward_dest String 外部来电 无应答 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
ex_no_answer_forward_prefix String 外部来电 无应答 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
ex_no_answer_forward_value String 外部来电 无应答 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
ex_no_answer_forward_num String 外部来电 无应答 前转目的地 external_num 的外部号码。
enb_ex_busy_forward Integer 是否在分机忙时将外部来电转移到指定目的地 (忙时 前转)。
  • 0：禁用
  • 1：启用
ex_busy_forward_dest String 外部来电 忙时 前转的目的地类型。
  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断
ex_busy_forward_prefix String 外部来电 忙时 前转的目的地类型不同，返回的参数值也不同。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数返回外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数返回问候语的播放次数。
ex_busy_forward_value String 外部来电 忙时 前转的目的地。
  • 当目的地类型为 play_greeting，此参数返回自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数返回目的地的 ID。

    例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。
ex_busy_forward_num String 外部来电 忙时 前转目的地 external_num 的外部号码。
ring_timeout Integer 来电响铃超时时间 (单位：秒)。
enb_ring_mobile Integer 分机响铃时，手机号码是否会同时响铃。
  • 0：禁用
  • 1：启用
mobile_prefix String “手机号码同时响铃” 功能的拨号前缀。
mobile_number String 手机号码。

示例

请求示例

查询分机 (ID: 39) 的详细信息。

GET /openapi/v1.0/extension/get?id=39&access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz 
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 39,
        "first_name": "Leo",
        "last_name": "Ball",
        "email_addr": "leo@sample.com",
        "mobile_number": "15880123456",
        "role_id": 1,
        "caller_id": "2000",
        "title": "",
        "reg_name": "2000",
        "reg_password": "",
        "concurrent_registrations": 1,
        "type": "SIP",
        "number": "2000",
        "dtmf_mode": "rfc4733",
        "enb_nat": 1,
        "enb_qualify": 1,
        "enb_srtp": 0,
        "enb_t38_support": 0,
        "transport": "udp",
        "enb_vm": 1,
        "enb_vm_pin": 1,
        "vm_pin": "6666",
        "new_vm_notification": "with_attach",
        "vm_after_notification": "delete",
        "allow_reg_remotely": 1,
        "disable_international_call": 0,
        "disable_outb_call_outside_business_hours": 0,
        "disable_outb_call": 0,
        "enb_mobile_client": 1,
        "enb_desktop_client": 1,
        "enb_web_client": 1,        
        "enb_internal_client": 1,
        "presence_status": "available",
        "agent_id": "5630",
        "presence_list": [
            {
                "status": "available",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "extension",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "2",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ivr",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "1",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "end_call",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 1,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            },
            {
                "status": "away",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ring_group",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "1",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "queue",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "1",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "group_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "1",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "play_greeting",
                "ex_busy_forward_prefix": "5",
                "ex_busy_forward_value": "demo.wav",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            },
            {
                "status": "business_trip",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "mobile_number",
                "in_no_answer_forward_prefix": "123",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "external_num",
                "in_busy_forward_prefix": "543",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "5235235235",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "group_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "1",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            },
            {
                "status": "do_not_disturb",
                "enb_in_always_forward": 1,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 1,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            },
            {
                "status": "lunch",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            },
            {
                "status": "off_work",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30
            }
        ],
       "enb_all_reject_mode_for_endpoints": 1,
       "linkus_mobile_codec": "g729",
       "enb_ice": "no"
    }
}