manualshive.com logo in svg

Yealink SIP VP-T49G, Developer'S Manual

Share
Download
Yealink SIP VP-T49G Developer'S Manual Download Page 16

XML Browser Developer’s Guide for Yealink IP Phones

 

6

 

The soft key line is a command line and will be used to display the labels of the 
available actions. 

 

The LCD screen and keys available for XML applications on a Yealink SIP-T48G IP 
phone are: 

 

15 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 key line is a command line and will be used to display the labels of the 
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 applications on a Yealink SIP-T46G/T29G IP 
phone are: 

 

10 text lines and 1 soft key line for the LCD screen 

Summary of Contents for SIP VP-T49G

Page 1: ...i i...

Page 2: ......

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

Page 4: ...me Development Guidelines 83 Configuring the HTTP Server 85 Configuring the Push XML Server 87 Yealink IP Phone XML Configurations 93 Configuring an XML Browser Key 93 Configuring the Block XML in Cal...

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

Page 6: ...The following section is new Configuring the Default Input Method on page 104 Major updates have occurred to the following sections XML display control and keys on Yealink IP phones on page 5 Yealink...

Page 7: ...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 9 Customizable Soft keys on page 78 Configuring an XML...

Page 8: ...ajor updates have occurred to the following section Yealink IP Phone XML Objects on page 9 Major updates have occurred to the following section Yealink IP Phone XML Objects on page 9 Major updates hav...

Page 9: ...About This Guide vii Configuring the Block XML in Calling on page 99 Major updates have occurred to the following section Yealink IP Phone XML Objects on page 9...

Page 10: ......

Page 11: ...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 12: ...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 13: ...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 14: ...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 15: ...e XML SIP Notify Figure2 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 pho...

Page 16: ...for the LCD screen The left and right arrow navigation keys The up and down arrow navigation keys The soft key line is a command line and will be used to display the labels of the available actions De...

Page 17: ...he left and right arrow navigation keys The up and down arrow navigation keys The soft key line is a command line and will be used to display the labels of the available actions Depending on the XML o...

Page 18: ...XML Browser Developer s Guide for Yealink IP Phones 8 available actions Depending on the XML object displayed on the phone the OK key as a confirm key...

Page 19: ...alink SIP T41P IP phones Yealink SIP T40P 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 SIP T19 P E2 IP phones Yea...

Page 20: ...ed none Beep 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 Dia...

Page 21: ...e 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 tag optional yes no...

Page 22: ...Pressing the off hook key is only applicable to CP860 IP phones Tapping is only applicable to SIP VP T49G SIP T48G IP phones Note If cancelAction is not left blank the function of X key is calling th...

Page 23: ...IP T48G T46G T 29G with space in title Select yes to display in multi lines and no for one line Default value is yes MenuItem Body mandatory none The element of the menu item Up to 30 instances minimu...

Page 24: ...is set to an HTTP URL the selection xxx defined by the Selection parameter will be appended to the URI when the user presses the Select soft key or the OK key Note Pressing the OK key is not applicabl...

Page 25: ...E2 IP phones SoftKey Index Label URI 1 Exit SoftKey Exit 4 Select SoftKey Select For SIP VP T49G SIP T48G IP phones SoftKey Index Label URI 1 Select SoftKey Select The function keys and soft keys are...

Page 26: ...f hook Key Off hook Pressing the line key Speakerphone Key Off hook key If the value of the LockIn is no and there is a number contained in the Dial tag the phone will dial out the number If the value...

Page 27: ...not applicable to SIP VP T49G SIP T19 P E2 CP860 IP phones OK Key Pressing the OK key The function of OK key is the same as that of Select Note Pressing the OK key is not applicable to SIP VP T49G IP...

Page 28: ...Speakerphone key the phone will dial 456 using the first available account Pressing the first line key the phone will dial 456 using the corresponding account Pressing the Select soft key or OK key t...

Page 29: ...own as below The TextScreen object allows users to display some texts on the IP phones XML description of the TextScreen object xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneTextScreen destroyOnEx...

Page 30: ...me XML object after exit Default value is no Beep Root tag optional yes no Whether to play a tone when the XML object is opened Default value is yes doneAction Root tag optional URI Define the URI to...

Page 31: ...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 The title...

Page 32: ...ones SoftKey Index Label URI 1 Exit SoftKey Exit The function keys and soft keys are listed in the following table Key Name Operation Function Up Down Key Pressing the up down key For CP860 SIP T46G T...

Page 33: ...l 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 left blank the function of X key is returning to the idle...

Page 34: ...screenshot of the SIP T23G IP phone user interface for reference is shown as below The screenshot of the SIP VP T49G IP phone user interface for reference is shown as below The screenshot of the SIP T...

Page 35: ...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 36: ...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 37: ...oot 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 optional...

Page 38: ...ling the URI defined by cancelAction 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 VP T49G SIP T19 P E2 CP860 IP...

Page 39: ...IP phones defaultInde x Root tag optional integer Position of the cursor If the value is not specified or exceeds the number of input boxes the cursor is positioned on the first input box Default valu...

Page 40: ...eUS timeInt dateUS dateInt Specifies the type of input Data input options 1 IP 2 string default 3 number 4 timeUS 12hour format Format HH MM SS AM PM HH 1 12 MM 0 59 SS 0 59 AM PM stand for the foreno...

Page 41: ...editable InputField tag optional yes no Whether to allow users to input something Default value is yes Users can not input anything if it is set to no Applicable scenario only allow some users to log...

Page 42: ...tion is automatic If the Selection parameter is omitted then nothing extra is appended Pressing the OK key is not applicable to SIP VP T49G IP phones Default InputField body optional string Default va...

Page 43: ...x Label URI 1 Dot SoftKey Dot 2 BackSpace SoftKey BackSpace 3 Submit SoftKey Submit For SIP VP T49G IP phones SoftKey Index Label URI 1 Submit SoftKey Submit If there is no soft key defined in the Inp...

Page 44: ...URI 1 Submit SoftKey Submit 2 BackSpace SoftKey BackSpace 4 Exit SoftKey Exit For SIP T48G IP phones SoftKey Index Label URI 1 BackSpace SoftKey BackSpace 2 Submit SoftKey Submit For SIP VP T49G IP ph...

Page 45: ...ey is not applicable to SIP VP T49G IP phones Left Right Key Pressing the left right key Move the cursor left and right Note Pressing the left right key is not applicable to SIP VP T49G CP860 IP phone...

Page 46: ...he value of the LockIn is yes the phone will be no response to any operation Note Pressing the line key is not applicable to SIP T19 P E2 CP860 IP phones Pressing the off hook key is only applicable t...

Page 47: ...YealinkIPPhoneInputScreen In this example when the user presses the Submit soft key or OK key on the phone after entering admin for the User Name and 222 for the password the phone will call the follo...

Page 48: ...is shown as below The screenshot of the SIP T48G IP phone user interface for reference is shown as below The screenshot of the SIP T46G IP phone user interface for reference is shown as below You can...

Page 49: ...I Timeout integer LockIn yes no Title wrap yes no Directory Title Title MenuItem Prompt Contact Name Prompt URI number URI MenuItem Additional Menu Items may be added Additional soft key items may be...

Page 50: ...tag optional yes no Whether to play a tone when the XML object is opened Default value is yes cancelActi on Root tag optional URI Define the URI to be called when the user cancels the XML object Timeo...

Page 51: ...es 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 The title of the addre...

Page 52: ...t the LCD screen displays the following default soft keys For CP860 IP T46G T42G T41P T40P T29G T27P T23P T23G T21 P E2 T19 P E2IP phones SoftKey Index Label URI 1 Send SoftKey Dial 2 Previous SoftKey...

Page 53: ...pplicable to SIP VP T49G IP phones Send Pressing the Send soft key Dial out the number of the highlighted contact Previous Pressing the Previous soft key Execute the URI defined by Previous Next Press...

Page 54: ...y is only applicable to CP860 IP phones Off hook is not applicable to CP860 IP phones Cancel Key Pressing the X key If cancelAction is not left blank the function of X key is calling the URI defined b...

Page 55: ...set the phone will dial 10 2 11 163 Pressing the Speakerphone key the phone will dial 10 2 11 163 Pressing the line key the phone will dial 10 2 11 163 Pressing the Previous soft key the phone will ca...

Page 56: ...interface for reference is shown as below The screenshot of the SIP T48G IP phone user interface for reference is shown as below The screenshot of the SIP T46G IP phone user interface for reference is...

Page 57: ...lightred lightgreen yellow lightblue lightmagenta lightcyan Message Message Additional Message Items may be added YealinkIPPhoneStatus The parameters of the Status object are listed in the following...

Page 58: ...r 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 VP T49G SIP T48G with small font size Up to...

Page 59: ...g optional white black red green brown blue magenta cyan lightgray darkgray lightred lightgreen yellow lightblue lightmage nta lightcyan Color of the line For CP860 SIP T42G T41P T40P T27P T23P T23G T...

Page 60: ...Size small 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...

Page 61: ...ncoding ISO 8859 1 YealinkIPPhoneStatus Beep yes SessionID 125 Timeout 600 Message Message Size normal Align center Color black Account Icon DND DND is enabled Message Message Size small Align right C...

Page 62: ...ommand item such as call user data download from server according to the URL etc Valid values are listed in the following tables Commonly used commands Name URI Value Function Supported URI http s mys...

Page 63: ...0 song wav the phone will play the ring tone stored on the server 10 3 6 128 Wav Stop tftp http username passw ord host port Path file Stop playing the WAV file e g if you set URI Wav Stop http 10 3 6...

Page 64: ...be red LINE d_ s d It represents the serial number of corresponding line key value range 1 29 for SIP VP T49G SIP T48G 1 27 for SIP T46G T29G 1 15 For SIP T42G T41P 1 21 for SIP T27P 1 3 For SIP T40P...

Page 65: ...P VP T49G SIP T19 P E2 CP860 IP phones UP Up key not applicable to SIP VP T49G IP phones DOWN Down key not applicable to SIP VP T49G IP phones LEFT Left key not applicable to SIP VP T49G CP860 IP phon...

Page 66: ...it key value 0 9 STAR key POUND key An example of the Execute object xml version 1 0 encoding ISO 8859 1 YealinkIPPhoneExecute Beep yes ExecuteItem URI Key OFF_HOOK YealinkIPPhoneExecute The IP phone...

Page 67: ...1 display_name 7002 Item Item account 1 user_name 7002 Item Item account 1 auth_name 7002 Item Item account 1 sip_server 1 address 10 2 1 199 Item YealinkIPPhoneConfiguration The IP phone registers ac...

Page 68: ...blue lightmagenta lightcyan Header Line Line Additional Line may be added Scroll Line Size normal small double large Align center left right Color white black red green brown blue magenta cyan lightgr...

Page 69: ...ult value is no doneAction Root tag optional URI Define the URI to be called when the user presses the OK key Note Pressing the OK key is not applicable to SIP VP T49G IP phones Beep Root tag optional...

Page 70: ...t value is no For more information refer to the function keys and soft keys table shown next Line Body mandatory string Text to be displayed on the line If the length of the text is too long to be dis...

Page 71: ...black For SIP VP T49G SIP T48G T46G T 29G IP phones Default value is white Scroll Body optional none Define the scrolling content for display The Line above the Scroll is as Header under the Scroll i...

Page 72: ...rkgray lightred lightgreen yellow lightblue lightmage nta lightcyan Color of the text For CP860 SIP T42G T41P T40P T27P T23P T23G T21 P E2 T19 P E2 IP phones This parameter will be ignored and the tex...

Page 73: ...pplicable to CP860 IP phones Exit from the current XML screen Off hook Line Key Speakerp hone Key Off hook Key Off hook Pressing the line key Speakerphone Key Off hook key If the value of the LockIn i...

Page 74: ...rge Align center Scroll line1 Line Line Align left Color black Scroll line2 Line Line Size small Align right Color white Scroll line3 Line Scroll Line Size small Align right Color white Footer line1 L...

Page 75: ...zontal and vertical alignment of the upper left hand corner along with the height and width of the image Note For SIP T42G SIP T41P SIP T40P SIP T27P SIP T23P G SIP T21 P E2 SIP T19 P E2 and CP860 IP...

Page 76: ...ters of the ImageScreen object are listed in the following table Parameter Position Type Value Description YealinkIPP honeImag eScreen Root tag mandatory none The root element of the ImageScreen objec...

Page 77: ...key is not applicable to SIP VP T49G SIP T19 P E2 CP860 IP phones Pressing the off hook key is only applicable to CP860 IP phones Tapping is only applicable to SIP VP T49G SIP T48G IP phones LockIn R...

Page 78: ...eight width Image tag mandatory For CP860 SIP T27P T23P T23G T21 P E2 T19 P E2 T42G T41P T 40P integer Width in pixels Must match the image width SoftKey Body optional string Refer to Customizable Sof...

Page 79: ...P E2 CP860 IP phones Pressing the off hook key is only applicable to CP860 IP phones Off hook is not applicable to CP860 IP phones Cancel Key Pressing the X key Return to the idle screen Note Pressing...

Page 80: ...eenshot of the SIP T23G IP phone user interface for reference is shown as below An example of the ImageScreen object for SIP VP T49G SIP T48G T46G T29G xml version 1 0 encoding ISO 8859 1 YealinkIPPho...

Page 81: ...YealinkIPPhoneImageMenu ImageMenu object is applicable to SIP VP T49G SIP T48G SIP T46G SIP T42G SIP T41P SIP T40P SIP T29G SIP T27P SIP T23P G SIP T21 P E2 SIP T19 P E2 and CP860 IP phones running f...

Page 82: ...tems may be added YealinkIPPhoneImageMenu The parameters of the ImageMenu object are listed in the following table Parameter Position Type Value Description YealinkIPPh oneImage Menu Root tag mandator...

Page 83: ...pressing the Exit soft key X key or off hook key or tapping Default value is 45 Note Pressing the X key is not applicable to SIP VP T49G SIP T19 P E2 CP860 IP phones Pressing the off hook key is only...

Page 84: ...image Default value is middle height Image tag mandatory For CP860 SIP T27P T23P T23G T21 P E2 T19 P E2 T42G T41P T 40P integer Height in pixels Must match the image height width Image tag mandatory F...

Page 85: ...se to any operation Exit Pressing the Exit soft key Tapping only for SIP VP T49G SIP T48G IP phones Pressing the on hook key only applicable to CP860 IP phones Exit from the current XML screen Off hoo...

Page 86: ...780000 Image 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 Te...

Page 87: ...ML new URI key 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 Tex...

Page 88: ...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 89: ...ubmit SoftKey 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...

Page 90: ...u style 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...

Page 91: ...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 92: ...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 93: ...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 94: ...XML Browser Developer s Guide for Yealink IP Phones 84...

Page 95: ...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 make sure the...

Page 96: ...XML Browser Developer s Guide for Yealink IP Phones 86...

Page 97: ...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 98: ...XML Browser Developer s Guide for Yealink IP Phones 88...

Page 99: ...Configure the Push XML Server 89...

Page 100: ...eveloper s Guide for Yealink IP Phones 90 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 101: ...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 102: ...XML Browser Developer s Guide for Yealink IP Phones 92 the address bar of the web browser and press the Enter key to push an XML object to the phone...

Page 103: ...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 the pull down list of Type 4 Enter the...

Page 104: ...rowser key on the IP phone The digit 27 stands for the key type XML Browser For line keys X ranges from 1 to 29 for SIP VP T49G SIP T48G X ranges from 1 to 27 for SIP T46G T29G X ranges from 1 to 15 f...

Page 105: ...en X 1 the default value is 28 History When X 2 the default value is 61 Directory When X 3 the default value is 5 DND When X 4 the default value is 30 Menu When X 12 the default value is 0 NA When X 1...

Page 106: ...X 2 the default value is 61 Directory When X 3 the default value is 5 DND When X 4 the default value is 30 Menu When X 5 the default value is 28 History When X 6 the default value is 61 Directory Whe...

Page 107: ...the default value is 0 NA When X 9 the default value is 33 Status When X 13 the default value is 0 NA When X 14 the default value is 2 Forward For CP860 IP phones When X 1 the default value is 28 Hist...

Page 108: ...3 14 for SIP T19 P E2 X 1 6 9 13 for CP860 Example linekey 1 value http 10 2 1 158 TextMenu xml Web User Interface DSSKey Line Key Programable Key Value Phone User Interface Menu Features DSS Keys Lin...

Page 109: ...ovisioning for configuration update For more information on auto provisioning refer to Yealink_SIP T2_Series_T19 P E2_T4_Series_CP860_IP_Phones_Auto_Provisioning_Guide You can configure the Block XML...

Page 110: ...in Calling using configuration files push_xml block_in_calling 1 2 Upload configuration files to the root directory of the provisioning server and trigger IP phones to perform an auto provisioning for...

Page 111: ...nk Description Configures the IP address of the push XML server Note Each IP address or domain name is separated by a comma If this field is left blank or the value is set as any the phone will reject...

Page 112: ...a POST message with the XML content In this example the phone will play a tone and display the information shown as below You can configure the XML SIP Notify via web user interface It will enable or...

Page 113: ...OTIFY message 0 Disabled 1 Enabled Web User Interface Features Remote Control SIP Notify Phone User Interface None The following shows an example of configuring Block XML In Calling using configuratio...

Page 114: ...nd 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 O...

Page 115: ...efault_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 default_...

Page 116: ...XML Browser Developer s Guide for Yealink IP Phones 106...

Page 117: ...nning 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 executing the XML ob...

Page 118: ...execute the XML object 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...

Page 119: ...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 successful a file wi...

Page 120: ...ML Browser Developer s Guide for Yealink IP Phones 110 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

Brands by name

Popular brands

Load more brands