分机组管理

分机组管理 - 创建分机组

接口说明

创建分机组

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.AddExtgroup
token string 是 通过授权接口获取的token
name string 是 分机组名
status int 否 分机组状态：0 启用；1 禁用，默认 0

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.AddExtgroup',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
        'status'  => 1
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "分机组添加成功",
        "reqtime": 1581410934,
        "rsptime": 1581410934
    },
    "msg": ""
}

返回数据字段说明

字段 说明

分机组管理 - 删除分机组

接口说明

删除分机组

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.DelExtgroup
token string 是 通过授权接口获取的token
name string 是 分机组名

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.DelExtgroup',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret":200,
    "data":{
        "status":0,
        "desc":"删除成功",
        "reqtime":1581409781,
        "rsptime":1581409781
    },
    "msg":""
}

返回数据字段说明

字段 说明

分机组管理 - 获取分机组列表

接口说明

获取当前用户拥有的分机组列表

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.GetExtgroupInfo
token string 是 通过授权接口获取的token
name string 否 分机组名，为空则获取所有

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.GetExtgroupInfo',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "获取成功",
        "result": [
            {
                "id": 18,
                "name": "test-group-3",
                "status": 1042
            }
        ],
        "reqtime": 1581408746,
        "rsptime": 1581408746
    },
    "msg": ""
}

返回字段说明

字段 类型 说明
result string 分机列表数组
—id string 分机组id
—name string 分机组名
—status string 分机组状态

分机组管理 - 分机签出分机组

接口说明

将当前用户下的分机从分机组中签出

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.DelExtnumber
token string 是 通过授权接口获取的token
name string 是 分机组名
extnumber string 是 分机号

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.DelExtnumber',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
        'extnumber'  => 'abcdefg'
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "删除成功",
        "reqtime": 1581409508,
        "rsptime": 1581409508
    },
    "msg": ""
}

返回数据字段说明

字段 类型 说明
desc string 返回描述

分机组管理 - 分机签入分机组

接口说明

将当前用户下的一个分机签入到用户拥有的一个分机组

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.AddExtnumber
token string 是 通过授权接口获取的token
name string 是 分机组名
extnumber string 是 分机号

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.AddExtnumber',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
        'extnumber'  => 'abcdefg'
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "添加成功",
        "reqtime": 1581409508,
        "rsptime": 1581409508
    },
    "msg": ""
}

返回数据字段说明

字段 类型 说明
desc string 返回描述

分机组管理 - 分机示闲示忙状态设置

接口说明

设置分机的闲忙状态

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.EditExtnumber
token string 是 通过授权接口获取的token
name string 是 分机组名
extnumber string 是 分机号
state string 是 分机状态 idle：示闲；busy：示忙

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.EditExtnumber',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
        'extnumber'  => '100001',
        'state'  => 'idle'
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "修改成功",
        "reqtime": 1581409508,
        "rsptime": 1581409508
    },
    "msg": ""
}

返回数据字段说明

字段 类型 说明
desc string 返回描述

分机组管理 - 获取分机组分机闲忙状态

接口说明

获取分机组中的分机状态

请求方式

POST，form-data格式

请求参数

参数名 类型 是否必须 说明
service string 是 App.Sip_Extgroup.GetGroupExt
token string 是 通过授权接口获取的token
name string 否 分机组名，为空则获取当前用户所有分机组数据
extnumber string 否 分机号，为空则获取当前用户所有分机数据

接口请求示例（PHP）

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Extgroup.GetGroupExt',
        'token'     => 'ABCDEFG',
        'name'  => 'abcdefg',
        'extnumber'  => 'abcdefg'
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": [
        {
            "name": "autocall-9026",
            "extnumber": "9026004",
            "status": "hangup",
            "priority": 1,
            "linkcount": 0,
            "date": null,
            "state": "idle"
        }
    ],
    "msg": ""
}

返回数据字段说明

字段 类型 说明
data string 分机号数据数组
—name string 分机组名
—extnumber string 分机号
—status string 分机状态 answer：应答；hangup：挂断
—priority string 优先级
—linkcount string 通话时长
—date string 更新时间
—state string 分机闲忙状态 idle：示闲； busy：示忙