Search Specific IP Phones

Search specific IP phones from the Auto Provisioning Phone list.

Request URL

GET {base_url}/{api_path}/phone/search?access_token={access_token}

Request parameters

Table 1.
Parameter	Required	Type	Description
page	No	Integer	Define which page is displayed.
page_size	No	Integer	Define how many records per page.
sort_by	No	String	Define the sorting field. Valid value: `vendor`: Phone vendor `model`: Phone model
order_by	No	String	Define the display order. Valid value: `asc`: Ascending order `desc`: Descending order
search_value	No	String	Search keyword.

Response parameters

Table 2.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
total_number	Integer	The total number of searched IP phones.
data	Array<Phone_Info>	The information of the searched IP phones.

Phone_Info

Table 3.
Parameter	Type	Description
id	Integer	The unique ID of the IP phone.
mac	String	The MAC address of the IP phone.
vendor	String	Phone vendor.
model	String	Phone model.
template_name	String	The name of the provisioning template applied to the IP phone.
ip	String	The private IP address of the IP phone. Note: This parameter always returns empty value.
firmware	String	The firmware version of the IP phone.
assigned_ext_status	String	The registration status of the extension assigned to the IP phone. `Unregistered` `Registered`
assigned_ext_num	String	The extension number of the extension assigned to the IP phone. Note: This parameter returns `Unassigned` if there is no extension assigned to the IP phone.
assigned_ext_name	String	The caller ID name of the extension assigned to the IP phone. Note: This parameter returns `Unassigned` if there is no extension assigned to the IP phone.
rps_pin	String	RPS PIN for Yealink phones, which can be entered on the phone device to complete the RPS provisioning process if required.
onsite_proxy_uuid	String	The UUID of associated Onsite Proxy instance.
function_key_line	Integer	The number of the SIP line. The function keys of extension assigned to the SIP line will be applied to the phone.
phonebook_line	Integer	The number of the SIP line. The phonebook of extension assigned to the SIP line will be applied to the phone.
assigned_list	Array<Extension_Info>	The information of the extensions assigned to the SIP lines for the IP phone.

Extension_Info


Parameter	Type	Description
status	String	The registration status of the extension assigned to the SIP line. `Unregistered` `Registered`
ext_num	String	The number of the extension assigned to the SIP line.
ext_name	String	The caller ID name of the extension assigned to the SIP line.
sip_line	Integer	The number of the SIP line.

Examples

Request example

GET /openapi/v1.0/phone/search?access_token=sSpTRV82rCV5Y8lOzb7yDBcRwvkqGjpe&page=1&page_size=3&sort_by=vendor&order_by=asc HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 36,
    "data": [
        {
            "id": 14,
            "mac": "3c:xx:xx:xx:xx:39",
            "vendor": "Alcatel-Lucent Enterprise",
            "model": "M8",
            "template_name": "YSDP_AleM8",
            "ip": "",
            "firmware": "2.13.01",
            "assigned_ext_status": "Unregistered",
            "assigned_ext_num": "2005",
            "assigned_ext_name": "Kristin Hale",
            "rps_pin":"",
            "onsite_proxy_uuid": "",
            "function_key_line": 1,
            "phonebook_line": 1,
            "assigned_list": [
                {
                    "status": "Unregistered",
                    "ext_num": "2005",
                    "ext_name": "Kristin Hale",
                    "sip_line": 1
                },
                {
                    "status": "Unregistered",
                    "ext_num": "2006",
                    "ext_name": "Emma Wilson",
                    "sip_line": 2
                }
            ]
        },
        {
            "id": 21,
            "mac": "3c:xx:xx:xx:xx:ae",
            "vendor": "Alcatel-Lucent Enterprise",
            "model": "M3",
            "template_name": "YSDP_AleMyriad",
            "ip": "",
            "firmware": "2.13.39",
            "assigned_ext_status": "Unregistered",
            "assigned_ext_num": "2007",
            "assigned_ext_name": "Ashley Gardner"
            "rps_pin":"",
            "onsite_proxy_uuid": "",
            "function_key_line": 2,
            "phonebook_line": 1,
            "assigned_list": [
                {
                    "status": "Unregistered",
                    "ext_num": "2007",
                    "ext_name": "Ashley Gardner",
                    "sip_line": 1
                },
                {
                    "status": "Registered",
                    "ext_num": "5555",
                    "ext_name": "Daniel Kim",
                    "sip_line": 2
                }
            ]
        },
        {
            "id": 48,
            "mac": "00:xx:xx:xx:xx:54",
            "vendor": "Cisco",
            "model": "Cisco3905",
            "template_name": "YSDP_Cisco3905",
            "ip": "",
            "firmware": "",
            "assigned_ext_status": "Registered",
            "assigned_ext_num": "2003",
            "assigned_ext_name": "Dave Haris"
            "rps_pin":"",
            "onsite_proxy_uuid": "",
            "function_key_line": 1,
            "phonebook_line": 1,
            "assigned_list": [
                {
                    "status": "Registered",
                    "ext_num": "2003",
                    "ext_name": "Dave Haris",
                    "sip_line": 1
                }
            ]
        },
      ... ...
    ]
}