编辑呼入路由

编辑呼入路由配置。

请求 URL

POST {base_url}/{api_path}/inbound_route/update?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
id 是 Integer 呼入路由的唯一 ID。
注： 可使用 搜索特定呼入路由 接口查询呼入路由 ID。
name 否 String 呼入路由名称。
alert_info 否 String 呼入路由特色响铃。
did_option 否 String DID 号码匹配模式。

取值范围：

  • patterns：匹配 DID 号码规则
  • pattern_to_ext：DID 号码规则匹配到分机
  • range_to_ext：DID 号码范围匹配到分机范围
  • pattern_to_ext_list：DID 号码匹配到指定分机。
did_pattern_list 否 Array<DID_Pattern_List> DID 号码匹配规则列表。
注： 此参数在 did_option 为 patterns 时必填。
did_pattern_to_ext 否 String 匹配到分机的 DID 号码匹配规则。
注： 此参数在 did_option 为 pattern_to_ext 时必填。
did_to_ext_start 否 String 匹配到分机范围的 DID 号码匹配规则起始号码。
注： 此参数在 did_option 为 range_to_ext 时必填。
did_to_ext_end 否 String 匹配到分机范围的 DID 号码匹配规则结束号码。
注： 此参数在 did_option 为 range_to_ext 时必填。
did_pattern_to_ext_list 否 Array<DID_Pattern_Ext_List> DID 号码和对应分机列表。
注： 此参数在 did_option 为 pattern_to_ext_list 时必填。
cid_option 否 String 主叫号码匹配规则。

取值范围：

  • patterns：来电匹配主叫号码规则
  • phonebook：来电匹配特定企业联系人群组
cid_pattern_list 否 Array<CID_Pattern_List> 主叫号码匹配规则列表。
注： 此参数在 cid_option 为 patterns 时必填。
cid_to_phonebook 否 Array<Integer> 来电匹配的企业联系人群组的唯一 ID。
注：
  • 此参数在 cid_option 为 phonebook 时必填。
  • 可使用 搜索特定企业联系人群组 接口查询企业联系人群组 ID。
  • 使用半角逗号 , 分隔多个 ID。
trunk_list 否 Array<Trunk_List> 呼入路由中选择的中继列表。
def_dest 否 String 呼入路由的默认目的地。
  • disabled
  • end_call：挂断
  • extension：分机
  • pattern_to_ext：匹配分机
  • range_to_ext：分机范围
  • pattern_to_ext_list：DID 号码匹配到指定分机。
  • ext_vm：分机语音信箱
  • ivr：IVR
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • conference：会议室
  • external_num：外部号码
  • outroute：呼出路由
  • play_greeting：播放问候语后挂断
  • fax_to_email：发送传真到邮箱
def_dest_prefix 否 String

此参数的设置取决于 def_dest 的设置值。

  • 当 def_dest 为 external_num，此参数用于设置外部号码的前缀。
  • 当 def_dest 为 play_greeting，此参数用于设置问候语的播放次数。
def_dest_value 否 String 此参数的设置取决于 def_dest 的设置值。
  • 当 def_dest 为 external_num，此参数用于输入外部号码。
  • 当 def_dest 为 play_greeting，此参数用于输入要播放的自定义提示音文件名。

    例如：Test.wav。

  • 当 def_dest 为 range_to_ext，此参数用于定义分机范围。

    例如：2001-2010。

  • 当 def_dest 为其他目的地，此参数输入目的地的唯一 ID。

    例如，目的地为分机 2002 或分机 2002 的邮箱，则此参数输入分机 2002 的唯一 ID。

    注： 可使用 获取菜单选项 接口查询需要的 ID。
def_dest_ext_list 否 Array<Ext_List> 选择的分机或分机组列表。
注： 此参数在 def_dest 为 pattern_to_ext 时必填。
DID_Pattern_List
表 2.
参数 是否必填 类型 说明
did_pattern 是 String DID 匹配规则。
注： 新的匹配规则会覆盖原本的设置。
DID_Pattern_Ext_List
参数 是否必填 类型 说明
did_pattern 是 String DID 号码。
did_pattern_to_ext 是 String DID 号码对应分机的 ID。
注： 可使用 搜索特定分机 接口查询需要的分机 ID。
CID_Pattern_List
表 3.
参数 是否必填 类型 说明
cid_pattern 是 String 主叫号码匹配规则。
注： 新的匹配规则会覆盖原本的设置。
Trunk_List
表 4.
参数 是否必填 类型 说明
id 是 Integer 中继的唯一 ID。
注： 可使用 搜索特定中继 接口查询中继 ID。
name 否 String 中继名称。
type 否 String 中继类型。
Ext_List
表 5.
参数 是否必填 类型 说明
value 是 String 分机/分机组的唯一 ID。
name 否 String 分机/分机组名称。
number 否 String 分机号码。
type 否 String 所选项目的类型。

取值范围：

  • extension：分机
  • ext_group：分机组

响应参数

表 6.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/inbound_route/update?access_token=zQcKT5W53FqJ72dCTMT1xKapH1YafYgs HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

{
    "id": 6,
    "alert_info": "02156325",
    "trunk_list": [
        {
           "id": 15
        }
    ],
    "did_pattern_list": [
        {
            "did_pattern": "999999"
        },
        {
            
            "did_pattern": "888888"
        }
    ],
    "cid_pattern_list": [
        {
            "cid_pattern": "777777"
        },
        {
            "cid_pattern": "666666"
        }
    ]
    
}

响应示例

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