Yealink SIP-T48G User Manual
  1. Manuals
  2. Brands
  3. Yealink Manuals
  4. IP Phone
  5. Yealink SIP-T48G
  6. User manual

Yealink SIP-T48G User Manual

Sip-t2 series sip-t19e2 series sip-t19pe2 series sip-t4 series
Hide thumbs Also See for SIP-T48G:
Table of Contents

Advertisement

Quick Links

See also: Administrator's Manual , User Manual
i
i

Advertisement

Table of Contents
loading

Related Manuals for Yealink SIP-T48G

Summary of Contents for Yealink SIP-T48G

  • Page 3: Table Of Contents

    How does it work? ......................4 Phone initiated application ..................4 Server initiated application ..................4 XML display control and keys on Yealink IP phones ..........5 Yealink IP Phone XML Objects ..........8 XML Object Definitions ....................8 TextMenu Object ...................... 9 TextScreen Object ....................
  • Page 4 XML Browser Developer’s Guide for Yealink IP Phones Configuration Object ..................... 49 FormattedTextScreen Object ................50 ImageScreen Object ..................... 57 ImageMenu Object ....................62 Customizable Soft keys ..................... 68 XML Objects Pushed to the Phone ................71 Some Development Guidelines ................73 Configuring the HTTP Server ..........
  • Page 5 XML browser simply means that the SIP phones’ LCD screen display can be managed by external applications. This guide shows you how to use XML API to control the LCD screen display of Yealink IP phones as well as its configuration. The XML API is intended to provide you with flexibility in developing applications on the phones while tightly integrating into the phone’s telephony capabilities and functions.
  • Page 6 The following section is new: Configuring the Default Input Method on page  Major updates have occurred to the following sections: XML display control and keys on Yealink IP phones on page  Yealink IP Phone XML Objects on page ...
  • Page 7 Major updates have occurred to the following section: Yealink IP Phone XML Objects on page  This version is updated to incorporate SIP-T48G IP phones. Major updates have occurred to the following section: Yealink IP Phone XML Objects on page ...
  • Page 8 Major updates have occurred to the following section: Yealink IP Phone XML Objects on page  Major updates have occurred to the following sections: XML display control and keys on Yealink IP phones on page  Yealink IP Phone XML Objects on page ...

  • Page 9: Xml And Yealink Ip Phones

    XML and Yealink IP Phones XML stands for extensible Markup Language. It is a markup language much like HTML. HTML is designed to display data and to focus on how data looks, while XML is designed to describe data and to focus on what data is.
  • Page 10 To respect XML recommendations, the following header can be set at the beginning of the XML document, <?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="UTF-8"?> Yealink provides XML object files beginning with the XML declaration “<?xml version="1.0" encoding="ISO-8859-1"?>”. For more information on XML, refer to http://www.xml.com/.
  • Page 11 XML and Yealink IP Phones The XML browser feature on Yealink IP phones allows users to develop and deploy custom services which meet user functional requirements on the server. Users can customize practical applications, such as weather report, stock information, Google search, news service, etc.

  • Page 12: Phone Initiated Application

    XML Browser Developer’s Guide for Yealink IP Phones Depending on the IP infrastructure, Yealink has supported developing the XML browser capability of the phones using HTTP . Yealink IP phones support two modes for XML browser applications: Phone-initiated  Server-initiated ...
  • Page 13 This chapter describes the available part of the LCD screen for each phone model of Yealink IP phones as well as the keys that are controlled by the XML objects. The LCD screen and keys available for XML applications on a Yealink SIP-T48G IP...
  • Page 14 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-T27P IP phone are: 7 text lines and 1 soft key line for the LCD screen ...
  • Page 15 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- T23P/T23G/T21(P) E2/T19(P) E2 IP phone are: 4 text lines and 1 soft key line for the LCD screen ...
  • Page 16 Yealink IP phones with a color graphical touch screen are: Yealink SIP-T48G IP phones  This section details each proprietary XML object supported by Yealink IP phones. You can ask the distributor or Yealink FAE for XML object files or obtain XML object files online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage. Note The size of an XML object cannot exceed 10000 bytes (10 kb).

  • Page 17: Yealink Ip Phone Xml Objects

    Yealink IP Phone XML Objects The TextMenu object allows users to create a list of menu items on the IP phones. You can use the TextMenu object to customize some functions such as weather report, stock information, new services, etc. You can browse the menu items by linking HTTP requests.
  • Page 18 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description return to the previous screen, and keep in the same XML object after exit. Default value is “no”. Position of the cursor. If the value is not specified...
  • Page 19 Yealink IP Phone XML Objects Parameter Position Type Value Description the phone will automatically exit from the TextMenu screen. If it is set to 0, the phone will not automatically exit from the TextMenu screen until pressing the “Exit” soft key or “X” key.
  • Page 20 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description SIP-T42G/T41P/T23P/T23G/ T21(P) E2/T19(P) E2 IP phones; not limit for SIP-T48G/T46G/T29G with space in title). Select “yes” to display in multi-lines, and “no” for one line. Default value is “yes”.

  • Page 21: Textmenu Object

    Yealink IP Phone XML Objects Parameter Position Type Value Description “selection” is automatic. If the Selection attribute is omitted, then nothing extra is appended to the URI. If the Selection parameter has more than one parameter, then these parameters are appended to the URI.
  • Page 22 XML Browser Developer’s Guide for Yealink IP Phones Key Name Operation Function up/down keys Left/Right Pressing the left/right Turn pages. keys If the value of the LockIn is “no”, the function of the digit key is highlighting a menu item. If the value of the LockIn is “yes”, the phone will be no response.
  • Page 23 Yealink IP Phone XML Objects Key Name Operation Function applicable to SIP-T19(P) E2 IP phones. If “cancelAction” is not left blank, the function of “X” key is calling the URI defined by “cancelAction”. Cancel Key Pressing the “X” key If “cancelAction” is left blank, the function of “X”...

  • Page 24: Textscreen Object

    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 interface for reference is shown as below: The screenshot of the SIP-T46G IP phone user interface for reference is shown as below:...
  • Page 25 Yealink IP Phone XML Objects XML description of the TextScreen object: <?xml version="1.0" encoding="ISO-8859-1"?> <YealinkIPPhoneTextScreen destroyOnExit="yes/no" Beep = "yes/no" doneAction = "URI" Timeout = "integer" cancelAction = "URI" LockIn = "yes/no"> <Title wrap = "yes/no">Text Title</Title > <Text>The screen text goes here</Text>...
  • Page 26 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description the TextScreen screen. If it is set to 0, the phone will not exit from the TextScreen screen until pressing the “Exit” soft key or “X” key.
  • Page 27 If there is no soft key defined in the TextScreen object, the LCD screen displays the following default soft key (the SIP-T48G IP phone does not display the soft key): For SIP-T46G/T42G/T41P/T29G/T27P/T23P/T23G/T21(P) E2/T19(P) E2 IP phones: SoftKey Index...
  • Page 28 <Text>The screen text goes here. When you see this, congratulations to you complete the configuration.</Text> </YealinkIPPhoneTextScreen> 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 interface for reference is shown as below:...

  • Page 29: Inputscreen Object

    Yealink IP Phone XML Objects The screenshot of the SIP-T46G IP phone user interface for reference is shown as below: The InputScreen object allows users to create a screen capable of gathering user input. It constructs and displays an input form, which prompts the users to input content, then sends the input content to the target URL.
  • Page 30 XML Browser Developer’s Guide for Yealink IP Phones <URL>Target receiving the input</URL> <Parameter> parameter name add to URL</Parameter> <Selection>Selection</Selection> <Default>Default Value</Default> </InputField> <!--Additional input field Items may be added --> <!--Additional soft key items may be added --> </YealinkIPPhoneInputScreen >...
  • Page 31 Yealink IP Phone XML Objects Parameter Position Type Value Description 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/01/2010 Note: The value in the root tag takes effect only if that in the InputField tag is left blank.
  • Page 32 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description automatically exit from the InputScreen screen. If it is set to 0, the phone will not exit from the InputScreen screen until pressing the “Exit” soft key or “X” key. Default value is 45.
  • Page 33 Yealink IP Phone XML Objects Parameter Position Type Value Description one line. (not applicable SIP-T42G/T41P/T23P/T23G/ T21(P) E2/T19(P) E2 IP phones) Position of the cursor. If the value is not specified or exceeds the number of defaultInde Root tag optional integer...
  • Page 34 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description HH:MM:SS AM/PM HH:1-12, MM:0-59, SS:0-59 AM/PM stand for the forenoon/afternoon. Example: 02:00:23 AM 12:59:00 PM 5. timeInt, 24 hour format Format: HH:MM:SS HH:0-23, MM:0-59, SS:0-59 Example: 23:25:00 6.
  • Page 35 Yealink IP Phone XML Objects Parameter Position Type Value Description higher priority than that in the root tag. Whether to allow users to input something. Default value is “yes”. Users can not input anything if it is set to “no”.
  • Page 36 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description automatic. If the Selection parameter is omitted, then nothing extra is appended. Default value to be displayed in input field. If “Default” is left blank, the input field will be...
  • Page 37 Yealink IP Phone XML Objects SoftKey Index Label Submit SoftKey:Submit If there is no soft key defined in the InputScreen object, and the Type for input box is “timeUS”, “timeInt”, “dateUS” or “dateInt”, the LCD screen displays the following default soft keys:...
  • Page 38 XML Browser Developer’s Guide for Yealink IP Phones For SIP-T46G/T42G/T41P/T29G/T27P/T23P/T23G/T21(P) E2/T19(P) E2 IP phones: SoftKey Index Label Submit SoftKey:Submit SoftKey:ChangeMode BackSpace SoftKey:BackSpace Dot (.) SoftKey:Dot NextSpace SoftKey:NextSpace Exit SoftKey:Exit For SIP-T48G IP phones: SoftKey Index Label SoftKey:ChangeMode BackSpace SoftKey:BackSpace Dot (.)
  • Page 39 Yealink IP Phone XML Objects Key Name Operation Function phones) Pressing the 2aB Input mode switch, e.g., switch the input soft key mode among “2aB”, “ABC”, “abc” or “123”. Pressing the Input a space in the input box at the cursor...
  • Page 40  is located in the Password input box. 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 interface for reference is shown as below:...

  • Page 41: Directory Object

    Yealink IP Phone XML Objects The screenshot of the SIP-T46G IP phone user interface for reference is shown as below: You can press the More soft key to find more soft keys. The Directory object allows users to browse an online directory in real time. The Directory object is just like a remote phonebook.
  • Page 42 XML Browser Developer’s Guide for Yealink IP Phones The parameters of the Directory object are listed in the following table: Parameter Position Type Value Description YealinkIPPh The root element of the oneDirecto Root tag mandatory none Directory object. Select “yes” to return to the previous XML object after exit.
  • Page 43 Yealink IP Phone XML Objects Parameter Position Type Value Description is set to 0, the phone will not exit from the Directory screen until pressing the “Exit” soft key or “X” key. Default value is 45. Note: If “cancelAction” is not left blank, the function of “X”...
  • Page 44 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description multi-lines, and “no” for one line. Default value is “yes”. Address item. MenuItem Body mandatory none (Value ranges from 1 to 30.) MenuItem The prompt of address...
  • Page 45 Yealink IP Phone XML Objects The function keys and soft keys are listed in the following table: Key Name Operation Function Up/Down Pressing the Browse a contact up and down. up/down keys Left/Right Pressing the Turn pages. left/right keys If the value of the LockIn is “no”, the function of the digit key is highlighting a contact.
  • Page 46 XML Browser Developer’s Guide for Yealink IP Phones Key Name Operation Function no response to any operation. If the value of the LockIn is “yes” and there is no number contained in the URI tag, the phone will be no response to any operation.
  • Page 47 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 interface for reference is shown as below: The screenshot of the SIP-T46G IP phone user interface for reference is shown as below:...

  • Page 48: Status Object

    XML Browser Developer’s Guide for Yealink IP Phones The Status object allows users to display a status message on a single designated line on the phone’s idle screen when XML information is pushed from the servers. The Status object can remind users of received messages, missed calls, news, notify, etc.
  • Page 49 Yealink IP Phone XML Objects Parameter Position Type Value Description same Session Note: The Session ID must be unique to the application sending the XML object to the phone. The time for status information display. The phone will automatically exit from the status...
  • Page 50 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description “small” “small”: 12 pt “double” “normal”: 18 pt “large” “double”: 24 pt “large”: 28 pt Default value is “normal”. SIP-T42G/T41P/T27P/T23P/T 23G/T21(P) E2/T19(P) E2: This parameter will be ignored.
  • Page 51 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 interface for reference is shown as below: The screenshot of the SIP-T46G IP phone user interface for reference is shown as below:...

  • Page 52: Execute Object

    XML Browser Developer’s Guide for Yealink IP Phones You can also remove status messages from the display using the same Session ID. This can be accomplished by setting an empty tag for the Message tag. For example, here is the XML object to remove the message in the first line.
  • Page 53 Yealink IP Phone XML Objects Parameter Position Type Value Description The operation of command item, such as call user, data download ExecuteIte ExecuteIte from server according to mandatory m URI m tag the URL, etc. Valid values are listed in the following tables.
  • Page 54 XML Browser Developer’s Guide for Yealink IP Phones Name URI Value Function Execute XXXX key operation. Key:XXXX See the following table for more information. Play the WAV file. (e.g., if you set URI=”Wav.Play:http://10. Wav.Play:[tftp|http://[username[:passw 3.6.128:8080/song.wav”, ord]@]<host>[:port][/<Path>]/<file> the phone will play the ring tone stored on the server 10.3.6.128.)
  • Page 55 (for EXP38, EXP39 and EXP40) For SIP-T48G: %d: It represents the serial number of “Led:LINE5_GREEN=on corresponding line key, value range: ”: 1~29 (for SIP-T48G), 1~27 (for Lighten the line key5 SIP-T46G/T29G), 1~15 (For background to be SIP-T42G/T41P), 1~21 (for SIP-T27P), 1~3 LINE%d_%s green.
  • Page 56 XML Browser Developer’s Guide for Yealink IP Phones Setting Method Indicator Example Up key DOWN Down key LEFT Left key RIGHT Right key Trigger to display the volume bar when you set the command once. INCREASE Increase volume when you set the command again.

  • Page 57: Configuration Object

    Yealink IP Phone XML Objects <ExecuteItem URI="Key:OK"/> </YealinkIPPhoneExecute> The IP phone enters the phone status screen. The Configuration object allows an external application to modify configuration of the IP phones dynamically. The configuration parameters are ones that are used in configuration files (Common.cfg and MAC.cfg) detailed in...
  • Page 58 XML Browser Developer’s Guide for Yealink IP Phones <Item>account.2.auth_name = 7002</Item> <Item>account.2.sip_server.1.address = 10.2.1.199</Item> </YealinkIPPhoneConfiguration> The IP phone registers account 7002 on line 2. The FormattedTextScreen object allows IP phones to display formatted (alignment, size, color and scrolling) texts on the LCD screen.

  • Page 59: Formattedtextscreen Object

    Yealink IP Phone XML Objects /darkgray/lightred/lightgreen/yellow/lightblue/lightmagenta/lightcyan" >Scroll 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/lightgray/darkgray /lightred/lightgreen/yellow/lightblue/lightmagenta/lightcyan" >Footer Line</Line> <!--Additional Line may be added--> <!--Additional Softkey Items may be added (softkey phones) --> </YealinkIPPhoneFormattedTextScreen > The parameters of the...
  • Page 60 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description the phone will automatically exit from the FormattedTextScreen screen. If it is set to 0, the phone will not exit from the FormattedTextScreen screen until pressing the “Exit”...
  • Page 61 Yealink IP Phone XML Objects Parameter Position Type Value Description “center” Alignment of the text. Align Line tag optional “left” Default value is “left” “right” “white” “black” “red” Color of the text. “green” “brown” SIP-T42G/T41P/T27P/T23P/ “blue” T23G/T21(P) E2/T19(P) E2 “magenta”...
  • Page 62 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description Default value is “normal”. SIP-T42G/T41P/T27P/T23P/ T23G/T21(P) E2/T19(P) E2 IP phones: This parameter will be ignored. “center” Line tag Alignment of the text. Align nested in optional “left”...
  • Page 63 Yealink IP Phone XML Objects If there is no soft key defined in the FormattedTextScreen object, the LCD screen displays the following default soft key (the SIP-T48G IP phone does not display the soft key): SoftKey Index Label Exit SoftKey:Exit...
  • Page 64 In this example, when you press the OK/√ key, the phone will call http://10.1.0.105/menu.php 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 interface for reference is shown as below:...
  • Page 65 Customizing an Image File on page 96. For SIP-T29G, SIP-T46G and SIP-T48G IP phones, the image is a “jpg”, “bmp” or “png” file located on a server, which can be downloaded by the phone. XML description of the ImageScreen object: <YealinkIPPhoneImageScreen...

  • Page 66: Imagescreen Object

    XML Browser Developer’s Guide for Yealink IP Phones The parameters of the ImageScreen object are listed in the following table: Parameter Position Type Value Description YealinkIPP The root element of the honeImag Root tag mandatory none ImageScreen object. eScreen Select “yes” to return to the previous XML object after exit.
  • Page 67 If there is no softkey defined in the ImageScreen object, the LCD screen displays the following default soft key (the SIP-T48G IP phone does not display the soft key): For SIP-T46G/T42G/T41P/T29G/T27P/T23P/T23G/T21(P) E2/T19(P) E2 IP phones: SoftKey Index...
  • Page 68 XML Browser Developer’s Guide for Yealink IP Phones The function keys and soft keys are listed in the following table: Key Name Operation Function Pressing the Exit soft key/Taping Exit Exit from the current XML screen. (only for SIP-T48G IP phones) If the value of the LockIn is “no”, the phone...
  • Page 69 <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> </YealinkIPPhoneImageScreen> In this example, when you press the OK/√ key, the phone will call http://10.1.0.105/menu.php The screenshot of the SIP-T48G IP phone user interface for reference is shown as below:...
  • Page 70 Customizing an Image File on page 96. For SIP-T29G, SIP-T46G and SIP-T48G IP phones, the image is a “jpg”, “bmp” or “png” file located on a server, which can be downloaded by the phone. XML description of the ImageMenu object: <?xml version="1.0"...
  • Page 71 Yealink IP Phone XML Objects <URIList base="URL"> <URI key=" 0-9,* or #">URL</URI> <!--Additional URI entries may be added (0-9,* and #)--> </URIList> <!--Additional Softkey Items may be added --> </YealinkIPPhoneImageMenu> The parameters of the ImageMenu object are listed in the following table:...
  • Page 72 XML Browser Developer’s Guide for Yealink IP Phones Parameter Position Type Value Description SIP-T19(P) E2 IP phones. If it is set to “yes”, the phone ignores specified function key events. “yes” Default value is “no”. For LockIn Root tag optional more information, refer “no”...
  • Page 73 Soft keys for more information. If there is no soft key defined in the ImageMenu object, the LCD screen displays the following default soft key (the SIP-T48G IP phone does not display the soft key): SoftKey Index Label Exit SoftKey:Exit...
  • Page 74 LockIn = "no" mode="regular"> <Image verticalAlign="middle" horizontalAlign="middle" height="81" width="59"> 000000000000000000000000000000…50ff08b2fd2db301780000</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="#">TextMenu.xml</URI> <URI key="0">Directory.xml</URI> <URI key="1">InputScreen.xml</URI> </URIList> </YealinkIPPhoneImageMenu>...
  • Page 75 Press the digit key 0 to enter the Directory screen.  Press the digit key 1 to enter the InputScreen screen.  Press the OK/√ key, the phone will call http://10.1.0.105/menu.php  The screenshot of the SIP-T48G IP phone user interface for reference is shown as below:...
  • Page 76 The screenshot of the SIP-T46G IP phone user interface for reference is shown as below: Yealink IP phones allow users to create soft keys with customizable labels, positions and actions to be taken when the soft keys are pressed. The customizable soft keys can override the default soft keys in each XML object.

  • Page 77: Imagemenu Object

    TextScreen Object Exit SoftKey:Exit Exit from the current XML screen. InputScreen Object (soft keys cannot be customized on SIP-T48G IP phones) Delete the character before the cursor in BackSpace SoftKey:BackSpace the input box. Execute the command comprised of the...
  • Page 78 XML Browser Developer’s Guide for Yealink IP Phones Label Function Exit SoftKey:Exit Exit from the current XML screen. An example of the customizable soft keys used with the TextMenu object: <?xml version="1.0" encoding="ISO-8859-1"?> <YealinkIPPhoneTextMenu style="none" Beep="no" Timeout="30" LockIn="no"> <Title wrap="yes">Phone Services</Title>...

  • Page 79: Configuring The Push Xml Server

    The phone can request an XML object via HTTP GET, or an object can be pushed to the phone via a POST. The phone parses this object immediately upon receipt and displays the information on the screen. You can ask the distributor or Yealink FAE for php source code or obtain php source code online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage.
  • Page 80 XML Browser Developer’s Guide for Yealink IP Phones flush(); fclose($fp); ############################## # The above codes are fixed, please just edit the following codes according to requirement. $xml = "the beginning of the root element in the XML object\n"; $xml . = "the child elements in the XML...
  • Page 81 Yealink IP Phone XML Objects fclose($fp); ############################## $xml = "<YealinkIPPhoneTextScreen Beep=\"yes\">\n"; $xml .= "<Title>Push test</Title>\n"; $xml .= "<Text>This is a test for pushing text to a phone.</Text>\n"; $xml .= "</YealinkIPPhoneTextScreen>\n"; #The above 4 lines prefixed with “$xml =” constructs a TextScreen object to be pushed to the #phone.
  • Page 82 XML Browser Developer’s Guide for Yealink IP Phones Yealink IP phones support downloading by using the HTTP (HTTPS) protocol. You can set up the HTTP(s) server, and place some XML files on the server for downloading. This section provides you with some instructions on how to configure the HTTP server and obtain the access URL of the XML files downloaded by the IP phones.
  • Page 83 Configure the Push XML Server XAMPP is a free, cross-platform, easy-to-use web server capable of serving dynamic pages. XAMPP consists mainly of the Apache HTTP Server, MySQL database and interpreters for scripts written in the PHP and Perl programming languages. XAMPP is an acronym for X (any of the four operating systems Windows, Linux, Sun Solaris and Mac OS X), Apache, MySQL, PHP and Perl.
  • Page 84 XML Browser Developer’s Guide for Yealink IP Phones...
  • Page 85 Configure the Push XML Server...
  • Page 86 XML Browser Developer’s Guide for Yealink IP Phones Click Finish to finish the installation. To start the XAMPP: Double click xampp-control.exe in the installation path of the XAMPP . Click Start next to the Apache module.
  • Page 87 Configure the Push XML Server Apache is running as shown below: You can also click Stop to stop Apache. Note Ensure ports 80 and 443 are not being used when starting the Apache server. To test the installation of the XAMPP: Enter “http://localhost/xampp/”in the address bar of the web browser and press the Enter key.
  • Page 88 XML Browser Developer’s Guide for Yealink IP Phones the address bar of the web browser, and press the Enter key to push an XML object to the phone.

  • Page 89: Yealink Ip Phone Xml Configurations

    Yealink IP Phone XML Configurations The followings take configurations of a SIP-T23G IP phone running firmware version 80 as examples. To use the XML browser feature, you must configure an XML key in advance. You can configure an XML Browser key via web user interface, phone user interface or configuration files.
  • Page 90 Configures a DSS key X as an XML Browser 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-T48G). X ranges from 1 to 27 (for SIP-T46G/T29G). X ranges from 1 to 15 (for SIP-T42G/T41P).
  • Page 91 Yealink IP Phone XML Configurations Parameters Permitted Values Default Default: For line keys: For SIP-T48G IP phones: The default value of the line key 1-16 is 15, and the default value of the line key 17-29 is 0. For SIP-T46G/T29G IP phones: The default value of the line key 1-16 is 15, and the default value of the line key 17-27 is 0.
  • Page 92 XML Browser Developer’s Guide for Yealink IP Phones Parameters Permitted Values Default 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=5, the default value is 28 (History).
  • Page 93 Description: Configures the available access URL to browser the XML object. For line keys: X ranges from 1 to 29 (for SIP-T48G). X ranges from 1 to 27 (for SIP-T46G/T29G). X ranges from 1 to 15 (for SIP-T42G/T41P). X ranges from 1 to 21 (for SIP-T27P).

  • Page 94: Configuring An Xml Browser Key

    (Optional.) Configures the label displaying on the LCD screen for each line key and each soft key. For line keys: X ranges from 1 to 29 (for SIP-T48G). X ranges from 1 to 27 (for SIP-T46G/T29G). X ranges from 1 to 15 (for SIP-T42G/T41P).
  • Page 95 Yealink IP Phone XML Configurations You can configure the Block XML in Calling via web user interface. It enables or disables the phone to block XML applications during a call. For example, if it is enabled, press a XML browser key when there is an active call on the phone, the XML application will be blocked.
  • Page 96 XML Browser Developer’s Guide for Yealink IP Phones The following shows an example of configuring Block XML in Calling using configuration files: push_xml.block_in_calling = 1 Upload configuration files to the root directory of the provisioning server and trigger IP phones to perform an auto provisioning for configuration update. For...
  • Page 97 Yealink IP Phone XML Configurations Parameter Permitted Values Default 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 HTTP POST messages from any server.
  • Page 98 XML Browser Developer’s Guide for Yealink IP Phones 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 disable SIP NOTIFY messages to be processed by the phone.
  • Page 99 Yealink IP Phone XML Configurations Parameter Permitted Values Default Description: Enables or disables the phone to process the push XML via SIP NOTIFY 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 configuration files: push_xml.sip_notify = 1...
  • Page 100 XML Browser Developer’s Guide for Yealink IP Phones Example of a SIP Notify with the XML content: In this example, the phone will play a tone and display the information shown as below: You can specify the default input method when the type of input is “string” in the InputScreen object.
  • Page 101 Yealink IP Phone XML Configurations The following table shows the information of parameter: Permitted Parameter Default Values Abc, 2aB, default_input_method.xml_browser_input_screen 123, abc or Description: Configures the default input method when the type for input box is set to “string” in the InputScreen object.
  • Page 102 XML Browser Developer’s Guide for Yealink IP Phones This chapter provides general troubleshooting information to help to solve the problems you might encounter when developing XML applications for Yealink IP phones. Besides, it also provides related troubleshooting tools and parsing error debug example for you to trace errors.

  • Page 103: Troubleshooting

    Troubleshooting Some of the XML editors (such as UltraEdit and Dreamweaver) can also verify the XML syntax and detail the related error in the output window. The following takes the Dreamweaver tool as an example for reference. After you execute the XML object, the LCD screen will prompt” File layout error !”. <?xml version="1.0"...
  • Page 104 “dob” file, and also provides a tool called “Dob2Text.exe” to convert a “dob” file to the hexadecimal string to be used for the ImageScreen and ImageMenu objects. Ask Yealink reseller or FAE for these two tools. For more information on how to convert a Yealink_SIP-T2_Series_T19(P) “bmp”...

  • Page 105: Appendix

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

This manual is also suitable for:

Sip-t41pSip-t46gSip-t42gSip-t29gSip-t27pSip-t23p/g ... Show all

Table of Contents