manualshive.com logo in svg

Yealink Yealink SIP-T48G, User Manual, Page: 6 / 105

Share
Download
Yealink Yealink SIP-T48G User Manual Download Page 6

XML Browser Developer’s Guide for Yealink IP Phones

 

iv

 

This section describes the changes to this guide for each release and guide version. 

Documentations of the newly released SIP-T19(P) E2 IP phones have been added. 

The following section is new: 

 

Configuring the Default Input Method 

on page

 92

 

Major updates have occurred to the following sections: 

 

XML display control and keys on Yealink IP phones 

on page

 5

 

 

Yealink IP Phone XML Objects

 on page 

8

 

 

TextMenu Object

 on page 

9

 

This version is updated to remove SIP-T28P, SIP-T26P, SIP-T22(P), SIP-T21(P), SIP-T20(P) and 
SIP-T19(P) IP phones. Documentations of the newly released SIP-T27P and SIP-T21(P) E2 
IP phones have also been added. 

Major updates have occurred to the following sections: 

 

XML display control and keys on Yealink IP phones 

on page

 5

 

 

Yealink IP Phone XML Objects

 on page 

8

 

 

Configuring an XML Browser Key 

on page

 81

 

Documentations of the newly released SIP-T29G IP phones have also been added. 
Major updates have occurred to the following sections: 

 

XML display control and keys on Yealink IP phones 

on page

 5

 

 

Yealink IP Phone XML Objects

 on page 

8

 

 

Customizable Soft keys 

on page

 68

 

 

Configuring an XML Browser Key 

on page

 81

 

Documentations of the newly released SIP-T23P/G IP phones have also been added. 
Major updates have occurred to the following sections: 

Summary of Contents for Yealink SIP-T48G

Page 1: ...i i...

Page 2: ......

Page 3: ...r Release 72 Guide Version 72 2 v Changes for Release 72 Guide Version 72 1 v Changes for Release 71 Guide Version 71 165 vi Changes for Release 71 Guide Version 71 140 vi Changes for Release 71 Guide...

Page 4: ...t Guidelines 73 Configuring the HTTP Server 74 Configuring the Push XML Server 75 Yealink IP Phone XML Configurations 81 Configuring an XML Browser Key 81 Configuring the Block XML in Calling 87 Confi...

Page 5: ...r This guide is designed specifically to provide development engineers system administrators or network engineers with information for developing and deploying customized client services to Yealink IP...

Page 6: ...and SIP T19 P IP phones Documentations of the newly released SIP T27P and SIP T21 P E2 IP phones have also been added Major updates have occurred to the following sections XML display control and key...

Page 7: ...ction Yealink IP Phone XML Objects on page 8 The following sections are new XML Format on page 2 Some Development Guidelines on page 73 Troubleshooting on page 94 Appendix on page 96 Major updates hav...

Page 8: ...IP phones on page 5 Yealink IP Phone XML Objects on page 8 Customizable Soft keys on page 68 XML Objects Pushed to the Phone on page 71 Documentations of the newly released SIP T19 P and SIP T21 P IP...

Page 9: ...ML tags are not predefined You must define your own tags XML uses an XML schema to describe the data XML with an XML schema is designed to be self descriptive XML is a W3C Standard Recommendation Samp...

Page 10: ...e root element The end tag must have the character XML tags are case sensitive Each attribute value should be within double quotations The texts within are considered as comments XML provides escape f...

Page 11: ...rver keep in mind that the content is not HTML All content comes to the IP phone either as plain text or text packaged in XML objects Yealink IP phones support 10 proprietary XML objects which allow t...

Page 12: ...HTTP s GET request message to the server waits for the answer decodes and displays this response message like any web browser such as Microsoft Internet Explorer or Firefox and would do as a web clien...

Page 13: ...gure2 Yealink IP phone acting as a server HTTP s post Figure3 Yealink IP phone acting as a server SIP NOTIFY This chapter describes the available part of the LCD screen for each phone model of Yealink...

Page 14: ...e available actions Depending on the XML object displayed on the phone the X key can also be interpreted as a cancel key and the OK key as a confirm key The LCD screen and keys available for XML appli...

Page 15: ...s on a Yealink SIP T23P T23G T21 P E2 T19 P E2 IP phone are 4 text lines and 1 soft key line for the LCD screen The left and right arrow navigation keys The up and down arrow navigation keys The soft...

Page 16: ...ink SIP T46G IP phones Yealink SIP T42G IP phones Yealink SIP T41P IP phones Yealink SIP T29G IP phones Yealink SIP T27P IP phones Yealink SIP T23P G IP phones Yealink SIP T21 P E2 IP phones Yealink S...

Page 17: ...yes no wrapList yes no Timeout integer cancelAction URI LockIn yes no Title wrap yes no Menu Title Title MenuItem Prompt First menu item Prompt URI HTTP s URL URI Dial Number for dial Dial Selection...

Page 18: ...Add a digit before each menu item for index none No sign before each menu item Beep Root tag optional yes no Whether to play a tone when the XML object is opened Default value is yes wrapList Root ta...

Page 19: ...lAction If cancelAction is left blank the function of X key is returning to the idle screen cancelActi on Root tag optional URI Define the URI to be called when the user cancels the XML object LockIn...

Page 20: ...menu item URI MenuItem body mandatory URI URI to be used if the user presses the Select soft key or OK key with the cursor on this menu item Dial MenuItem body optional Phone number Define what numbe...

Page 21: ...selection 0 menu _pos 1 when the user presses the Select soft key SoftKey Body optional string Refer to Customizable Soft keys for more information If there is no soft key defined in the TextMenu obj...

Page 22: ...P phones Exit from the current XML screen Off hook Line Key Hands free Key Off hook Pressing the line key Hands free key If the value of the LockIn is no and there is a number contained in the Dial ta...

Page 23: ...ject xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneTextMenu style numbered Beep no Timeout 30 LockIn no Title wrap yes Phone Services Title MenuItem Prompt Ask Google Prompt URI http 10 2 11 158 y...

Page 24: ...all http 10 2 11 158 yealink google google php user selection 12345 The screenshot of the SIP T23G IP phone user interface for reference is shown as below The screenshot of the SIP T48G IP phone user...

Page 25: ...pe Value Description YealinkIPPh oneTextScr een Root tag mandatory none The root element of the TextScreen object destroyOn Exit Root tag optional yes no Select yes to return to the previous XML objec...

Page 26: ...no If it is set to yes the phone ignores specified function key events Default value is no For more information refer to the function keys and soft keys table shown next Title Body mandatory string T...

Page 27: ...29G T27P T23P T23G T21 P E2 T19 P E2 Browse texts line by line For SIP T48G Turn pages Left Right Key Pressing the left right keys For SIP T48G T46G and SIP T29G Turn pages not applicable to SIP T42G...

Page 28: ...of the TextScreen object xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneTextScreen doneAction http 10 2 11 158 cancel php Timeout 15 LockIn no Beep no Title wrap yes Screen Title Title Text The scr...

Page 29: ...on to server You can define the content and format of the input content XML description of the InputScreen object xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneInputScreen destroyOnExit yes no typ...

Page 30: ...YealinkIPPh oneInputSc reen Root tag mandatory none The root element of the InputScreen object destroyOn Exit Root tag optional yes no Select yes to return to the previous XML object after exit Selec...

Page 31: ...root tag takes effect only if that in the InputField tag is left blank Beep Root tag optional yes no Whether to play a tone when the XML object is opened Default value is yes Password Root tag option...

Page 32: ...reen Note Pressing the X key is not applicable to SIP T19 P E2 IP phones LockIn Root tag optional yes no If it is set to yes the phone ignores specified function key events Default value is no For mor...

Page 33: ...hether to display the title in multi lines when the content of the title is more than one line up to 3 lines for SIP T27 IP phones up to 2 lines for SIP T42G T41P T23P T23G T21 P E2 T19 P E2 IP phones...

Page 34: ...HH MM SS HH 0 23 MM 0 59 SS 0 59 Example 23 25 00 6 dateUS Format MM DD YYYY MM 1 12 DD 1 31 YYYY 000 0 9999 Example 12 31 2009 7 dateInt Format DD MM YYYY DD 1 31 MM 1 12 YYYY 000 0 9999 Example 31...

Page 35: ...InputField body optional string The prompt of user input Parameter InputField body mandatory string Name of parameter to be appended to the URL The parameter name the user input will be appended to th...

Page 36: ...ill change according to the attribute value of type Refer to Customizable Soft keys for more information Note If there is no soft key defined in the InputScreen object and the Type for input box is IP...

Page 37: ...SoftKey Index Label URI 1 2aB SoftKey ChangeMode 2 BackSpace SoftKey BackSpace 3 Submit SoftKey Submit If there is no soft key defined in the InputScreen object and the Type for input box is number th...

Page 38: ...the following table Key Name Operation Function Up Down Key Pressing the up down keys Browse the input box up and down Left Right Key Pressing the Left right keys Move the cursor left and right Keypa...

Page 39: ...key is not applicable to SIP T19 P E2 IP phones Cancel Key Pressing the X key If cancelAction is not left blank the function of X key is calling the URI defined by cancelAction If cancelAction is lef...

Page 40: ...in for the User Name and 222 for the password the phone will call the following URLs http 10 3 5 5 proxy admin proxy 222 selection 1 if the position of the cursor is located in the User Name input box...

Page 41: ...ntact with the cursor the contact can be dialed directly by pressing the Send soft key picking up the handset or pressing the line key or the speakerphone key XML description of the Directory object x...

Page 42: ...the cursor If the value is not specified or exceeds the number of menu items the cursor will position on the first menu item Default value is 1 next Root tag optional URI Define the URI to be called w...

Page 43: ...is not applicable to SIP T19 P E2 IP phones LockIn Root tag optional yes no If it is set to yes the phone ignores specified function key events Default value is no For more information refer to the f...

Page 44: ...g Refer to Customizable Soft keys for more information If there is no soft key defined in the Directory object the LCD screen displays the following default soft keys For SIP T46G T42G T41P T29G T27P...

Page 45: ...Previous Pressing the Previous soft key Execute the URI defined by Previous Next Pressing the Next soft key Execute the URI defined by Next Exit Pressing the Exit soft key Taping only for SIP T48G IP...

Page 46: ...If cancelAction is left blank the function of X key is returning to the idle screen Note Pressing the X key is not applicable to SIP T19 P E2 IP phones OK Key Pressing the OK key The function of OK k...

Page 47: ...ssing the Previous soft key the phone will call http 10 3 5 198 ImageScreen xml Pressing the Next soft key the phone will call http 10 3 5 198 ImageMenu xml Pressing the X key the phone will call http...

Page 48: ...er left right Color white black red green brown blue magenta cyan lightgray darkgray lightred lightgreen yellow lightblue lightmagenta lightcyan Message Message Additional Message Items may be added Y...

Page 49: ...exit from the status screen until the server sends a cancel request or the phone reboots Message Body optional string Message to be displayed or empty to reset the message Up to 10 instances for SIP...

Page 50: ...t Alignment of the message display Default value is left Color Message tag optional white black red green brown blue magenta cyan lightgray darkgray lightred lightgreen yellow lightblue lightmage nta...

Page 51: ...all Align right Color green Account Icon Message 1 New Message Message YealinkIPPhoneStatus The screenshot of the SIP T23G IP phone user interface for reference is shown as below The screenshot of the...

Page 52: ...1 New Message Message YealinkIPPhoneStatus The Execute object allows an external application to ask the phone to execute a sequence of local commands using URIs The phone will execute each specified...

Page 53: ...m the root directory on the server myserver com Note If more than one object is executed we recommend you separate the object which requires a reboot Otherwise other objects will not to be executed af...

Page 54: ...ong wav the phone will stop to play the ring tone stored on the server 10 3 6 128 Phone Reset Command Reset Reset to the factory when the phone is idle Phone Fast Reboot Command Reboot Reboot the phon...

Page 55: ...3P T23G and 1 2 For SIP T21 P E2 s The light color values RED GREEN and ORANGE For SIP T48G Led LINE5_GREEN on Lighten the line key5 background to be green For others Led LINE5_GREEN on Lighten the li...

Page 56: ...ecrease volume when you set the command again REDIAL Redial key HOLD Hold the line MUTE Mute CONFERENCE Conference TRANSFER Transfer SMS Message key HEADSET Activate the headset mode HANDFREE Hands fr...

Page 57: ...yes no Item parameter value Item Additional Configuration Items may be added up to 1300 YealinkIPPhoneConfiguration The parameters of the Configuration object are listed in the following table Paramet...

Page 58: ...r the Header block How many lines of text can be displayed on this block depends on the size of the LCD screen The Footer block is displayed at the bottom of the LCD screen with static text This block...

Page 59: ...object are listed in the following table Parameter Position Type Value Description YealinkIPPh oneFormatt edTextScre en Root tag mandatory none The root element of the FormattedTextScreen object destr...

Page 60: ...ptional yes no If it is set to yes the phone ignores specified function key events Default value is no For more information refer to the function keys and soft keys table shown next Line Body mandator...

Page 61: ...ameter will be ignored and the text displayed is always black For SIP T48G T46G T29G IP phones Default value is white Scroll Body optional none Define the scrolling content for display The Line above...

Page 62: ...the text Default value is left Color Line tag nested in scroll body optional white black red green brown blue magenta cyan lightgray darkgray lightred lightgreen yellow lightblue lightmage nta lightcy...

Page 63: ...he Exit soft key Taping only for SIP T48G IP phones Exit from the current XML screen Off hook Line Key Hands fre e Key Off hook Pressing the line key Hands free key If the value of the LockIn is no th...

Page 64: ...e Size small Align right Color white Scroll line3 Line Scroll Line Size small Align right Color white Footer line1 Line YealinkIPPhoneFormattedTextScreen In this example when you press the OK key the...

Page 65: ...yes no Timeout integer LockIn yes no mode regular fullscreen Image horizontalAlign right middle left verticalAlign top middle bottom height integer width integer Image as hexadecimal characters or URL...

Page 66: ...Define the URI to be called when the user presses the OK key Beep Root tag optional yes no Whether to play a tone when the XML object is opened Default value is yes Timeout Root tag optional integer I...

Page 67: ...l top middle bottom Horizontal position of the image Default value is middle height Image tag mandatory For SIP T27P T23P T 23G T21 P E2 T19 P E2 T42G T41P integer Height in pixels Must match the imag...

Page 68: ...ble to SIP T19 P E2 IP phones Cancel Key Pressing the X key Return to the idle screen Note Pressing the X key is not applicable to SIP T19 P E2 IP phones OK Key Pressing the OK key The function of OK...

Page 69: ...ing ISO 8859 1 YealinkIPPhoneImageScreen doneAction http 10 1 0 105 menu php Beep yes Timeout 60 LockIn no mode regular Image horizontalAlign middle verticalAlign middle http 10 3 5 198 test jpg Image...

Page 70: ...age horizontalAlign right middle left verticalAlign top middle bottom height integer width integer Image as hexadecimal characters or URL Image ImageMenu object is applicable to SIP T48G SIP T46G SIP...

Page 71: ...us XML object after exit Select no to return to the previous screen and keep in the same XML object after exit Default value is no doneAction Root tag optional URI Define the URI to be called when the...

Page 72: ...Image as hexadecimal characters for SIP T42G T41P T27P T23P T23G T21 P E2 T19 P E2 or URL for SIP T48G T46G T29G horizontalA lign Image tag optional left middle right Vertical position of the image D...

Page 73: ...e function keys and soft keys are listed in the following table Key Name Operation Function Keypad Pressing the digit keys 0 9 and keys If the value of the LockIn is no the function is triggering the...

Page 74: ...Here just provide portion of hexadecimal string use Yealink supplied tool Dob2Text exe to convert a dob file to the hexadecimal string URIList base http 10 3 6 129 8080 XML new URI key TextMenu xml UR...

Page 75: ...ey TextMenu xml URI URI key 0 Directory xml URI URI key 1 InputScreen xml URI URIList YealinkIPPhoneImageMenu In this example you can do the followings Press the pound key to enter the TextMenu screen...

Page 76: ...Description SoftKey mandatory none The soft key Index mandatory Integer Indicate the soft key number Value ranges from 1 6 Label mandatory String The label of the soft key URI mandatory String The act...

Page 77: ...Submit Execute the command comprised of the URI and input content NextSpace SoftKey NextSpace Insert a space in the input box at the cursor position Dot SoftKey Dot Input a in the input box at the cur...

Page 78: ...none Beep no Timeout 30 LockIn no Title wrap yes Phone Services Title MenuItem Prompt Ask Google Prompt URI http 10 2 11 158 yealink google google php user URI Dial 456 Dial MenuItem MenuItem Prompt C...

Page 79: ...after the equals sign in the message HTML forms that post objects to the phone must use a field named xml to send data The applications that construct HTTP packets must also specify this line To acce...

Page 80: ...ss Phone IP Address xml replace IP address of the push XML server with Server IP Address replace IP address of the phone with Phone IP Address Sample php source code In this example the IP address of...

Page 81: ...XML object using the same method push2phone 192 168 0 112 192 168 0 150 xml There are some simple rules that you had better follow when you develop XML applications for Yealink IP phones Do not forget...

Page 82: ...server using HFS application 1 Double click the HFS exe 2 Click Menu in the main page and select the IP address of the PC from IP address The default HTTP port is 80 You can also reset the HTTP port m...

Page 83: ...che MySQL PHP and Perl This section shows you how to install XAMPP on Microsoft Windows system The XAMPP software is available for free You can download it from http www apachefriends org index html W...

Page 84: ...XML Browser Developer s Guide for Yealink IP Phones 76...

Page 85: ...Configure the Push XML Server 77...

Page 86: ...eveloper s Guide for Yealink IP Phones 78 3 Click Finish to finish the installation To start the XAMPP 1 Double click xampp control exe in the installation path of the XAMPP 2 Click Start next to the...

Page 87: ...er the XAMPP server is installed in your local system and Apache is already started you can find the htdocs directory in the installation path For example C xampp of the XAMPP 1 Place the php file use...

Page 88: ...XML Browser Developer s Guide for Yealink IP Phones 80 the address bar of the web browser and press the Enter key to push an XML object to the phone...

Page 89: ...o configure an XML Browser key via web user interface 1 Access the web user interface of the phone 2 Click on DSSKey Line Key or Programable Key 3 In the desired DSS key field select XML Browser from...

Page 90: ...parameters Parameters Permitted Values Default linekey X type programablekey X type 27 Refer to the following content Description Configures a DSS key X as an XML Browser key on the IP phone The digi...

Page 91: ...ault value of the line key 1 6 is 15 and the default value of the line key 7 21 is 0 For SIP T23P T23G T21 P E2 IP phones The default value is 15 For programable keys For SIP T48G T46G IP phones When...

Page 92: ...the default value is 30 Menu When X 5 the default value is 28 History When X 6 the default value is 61 Directory When X 7 the default value is 51 Switch Account Up When X 8 the default value is 52 Swi...

Page 93: ...the default value is 0 NA When X 14 the default value is 2 Forward Web User Interface DSSKey Line Key Programable Key Type Phone User Interface Menu Features DSS Keys Line Key X Type linekey X value...

Page 94: ...ges from 1 to 21 for SIP T27P X ranges from 1 to 3 for SIP T23P G X ranges from 1 to 2 for SIP T21 P E2 For programable keys X ranges from 1 to 4 Example linekey 1 label XML Browser Web User Interface...

Page 95: ...phone 2 Click on Features Remote Control 3 Select the desired value from the pull down list of Block XML in Calling field 4 Click Confirm to accept the change To configure the Block XML in Calling us...

Page 96: ...on the IP phone will be able to accept the HTTP s POST from the server To configure the Push XML Server via web user interface 1 Access the web user interface of the phone 2 Click on Features Remote C...

Page 97: ...r Interface None The following shows an example of configuring push XML server using configuration files push_xml server 10 3 6 158 2 Upload configuration files to the root directory of the provisioni...

Page 98: ...To configure the XML SIP Notify via web user interface 1 Access the web user interface of the phone 2 Click on Features Remote Control 3 Select Enabled from the pull down list of SIP Notify field 4 C...

Page 99: ...onfiguring Block XML In Calling using configuration files push_xml sip_notify 1 2 Upload configuration files to the root directory of the provisioning server and trigger IP phones to perform an auto p...

Page 100: ...d display the information shown as below You can specify the default input method when the type of input is string in the InputScreen object For more information on InputScreen refer to InputScreen Ob...

Page 101: ...e default_input_method xml_browser_input_screen 2aB Web User Interface None Phone User Interface None The following shows an example of configuring default input method using configuration files defau...

Page 102: ...application is running properly Ensure that the URI is resolved Ensure that the XML object file exists on the server Ensure that the URI is parsed Why does the phone display File layout error when ex...

Page 103: ...ect the LCD screen will prompt File layout error xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneStatus Beep yes SessionID 125 Timeout 600 Message Message Size normal Align center Color black Accoun...

Page 104: ...rted in the same directory of your local system 2 Double click Dob2Text exe to launch the application 3 Enter the name of the dob file e g Yealink dob and press the Enter key If the conversion is succ...

Page 105: ...Appendix 97 We are striving to improve our documentation quality and we appreciate your feedback Email your opinions and comments to DocsFeedback yealink com...

Reviews:

No comments