查询自动配置的配置选项

查询添加 IP 话机进行自动配置时所需配置选项的信息。

请求 URL

GET {base_url}/{api_path}/auto_provisioning/compatibility?access_token={access_token}

请求参数

1.
参数 是否必填 类型 说明
menu String 要查询的配置选项。
取值范围
  • phone_vendor:话机供应商
  • phone_model:话机型号
  • phone_template:话机可用的配置模板
  • autop_method:话机支持的自动配置方式
vendor String 话机供应商。
注: 此参数在查询 phone_modelautop_method 时必填。
model String 话机型号。
注: 此参数在查询 phone_templateautop_method 时必填。

响应参数

2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Array<Option_Info> 可用选项的信息。
Option_Info
3.
参数 类型 说明
text String 可用选项的名称。
注: 查询自动配置方式时,该字段返回具体配置方式的配置链接。
value String 可用选项的参数值。
type String 可用选项的类型。

示例

查询支持的话机供应商
查询支持的话机供应商信息。
请求示例
GET /openapi/v1.0/auto_provisioning/compatibility?access_token=Gm4Vj4CUq2GsfCprykiv0mE0KHNc52HV&menu=phone_vendor HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "Alcatel-Lucent Enterprise",   //话机供应商名称
            "value": "Ale",                        //话机供应商参数值
            "type": "Deskphone"                    //话机类型
        },
        ... ...
       {
            "text": "Yealink",
            "value": "Yealink",
            "type": "Deskphone"
        }
    ]
}
查询指定话机供应商下支持的话机型号
查询支持的 Yealink 话机型号。
请求示例
GET /openapi/v1.0/auto_provisioning/compatibility?access_token=fy59UJHFHJvOMthVlQM4z9sq6gFHcZVn&menu=phone_model&vendor=Yealink HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "CP920",                //话机型号名称
            "value": "CP920",               //话机型号参数值
            "type": "Conferencephone"       //话机类型
        },
         ... ...
        {
            "text": "SIP-W80DM",
            "value": "SIP-W80DM",
            "type": "DECT"
        },
         ... ...
        {
            "text": "VP59",
            "value": "VP59",
            "type": "Deskphone"
        }
    ]
}
查询指定话机型号可用的配置模板
查询 Yealink 话机 CP920 可用的自动配置模板。
请求示例
GET /openapi/v1.0/auto_provisioning/compatibility?access_token=fy59UJHFHJvOMthVlQM4z9sq6gFHcZVn&menu=phone_template&model=CP920 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "YSDP_YealinkCP",   //模板名称
            "value": "24"               //模板的唯一 ID
        }
    ]
}
查询指定话机型号支持的自动配置方式
查询 Yealink 话机 CP920 支持的自动配置方式。
请求示例
GET /openapi/v1.0/auto_provisioning/compatibility?access_token=fy59UJHFHJvOMthVlQM4z9sq6gFHcZVn&menu=autop_method&vendor=Yealink&model=CP920 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "yeastardocs.example.yeastarcloud.com:443/api/autoprovision/6gEzigLFhMGntjd8",   //配置链接
            "value": "rps",                                                                          //配置方式
            "type": "full"                                                                           //配置方式类型
        }
    ]
}