添加广播组

添加并配置广播组。

请求 URL

POST {base_url}/{api_path}/paging/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
number 是 String 广播组号码。
name 是 String 广播组名称。
type 是 String 广播组类型。

取值范围：

  • 1_way_paging：单向传呼
  • 1_way_multicast_paging：单向组播
  • 2_way_intercom：双向对讲
prompt 否 String 广播前播放的提示音。
注： 可通过 获取菜单选项 接口查询可用的自定义提示音。
prompt_play_times 是 Integer 提示音播放次数。

取值范围：0-100，0表示循环播放。
broadcast 否 Array<Broadcast> 广播者。
broadcast_client 是 String 接收广播的客户端。

取值范围：

  • exten：话机端
  • linkus：Linkus 手机端
  • pc：Linkus 桌面端
  • web：Linkus 网页端
  • pad：Linkus 平板端 (SDK)
注： 用 &分隔多个客户端。
dial_star_to_answer 否 Integer 是否允许成员按 * 与广播者对话。

取值范围：

  • 0：禁用
  • 1：启用
dial_hash_to_stop_prompt 否 Integer 是否允许广播者在提示音播放过程中按 # 停止播放。

取值范围：

  • 0：禁用
  • 1：启用
play_prompt_to_broadcaster 否 Integer 是否向广播者播放提示音。

取值范围：

  • 0：禁用
  • 1：启用
member_list 否 Array<Member_List> 单向传呼或双向对讲的成员。
注： 用于单向传呼或双向对讲的广播组，必须填写此参数。
multicast_ip_list 否 Array<Multicast_IP_List> 单向组播的 IP 地址。
注： 用于单向组播的广播组，必须填写此参数。
Broadcast
参数 是否必填 类型 说明
id 否 Array 分机或分机组的唯一 ID。
注： 可使用 获取菜单选项 接口查询分机 ID 或分机组 ID。
Member_List
参数 是否必填 类型 说明
id 是 Array 分机或分机组的唯一 ID。
注： 可使用 获取菜单选项 接口查询分机 ID 或分机组 ID。
Multicast_IP_List
参数 是否必填 类型 说明
multicast_ip 是 String 组播 IP 地址。
multicast_port 是 Integer 组播端口。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 广播组的唯一 ID。

示例

请求示例

POST /openapi/v1.0/paging/create?access_token=iTtFoTQObinMGCpXzbtD8gnDaR2r8UJP HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "number": "6605",
    "name": "6605",
    "type": "1_way_paging",
    "prompt":"welcome.wav",
    "prompt_play_times": 1,
    "broadcast":["80"],
    "broadcast_client": "exten&linkus",
    "dial_star_to_answer": 0,
    "dial_hash_to_stop_prompt":1,
    "play_prompt_to_broadcaster": 1,
    "member_list":["83","84"]
}

响应示例

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