Translating or customizing SIP error responses

Language files

Starting with version 10.1.41.0,  SIP error response phrases can be added as language phrases into Language files. The following language file is currently supported:

1. Phone User Interface language files (<phrases> tag):

   <phrases> tag Syntax Expand source

   <?xml version="1.0" encoding="utf-8"?>
    <phrases>
     <phrase i="<index>" n="<name>" t="<translation>"/>
     ...
     <phrase i="<index>" n="<name>" t="<translation>"/>
     <language i="<index>" t="<language name>"/>
    </phrases>

2. phrase tag defines one Phone User Interface phrase
   • "i string" represents the running <index> of the phrases
   • "n string" represents the internally used (english) variable <name> used for the translation
   • "t string" represents the <translation>
     
     
3. language tag defines the language name
   • "i string" represents the <index> of the language name, usually equal 0
   • "t string" represents the <language name>, should match the name string used in (<gui-languages> tag)

The following SIP response phrases are currently supported:

• I. e.: <phrase n="lang_sip_response_code_400" t="Bad Request"/>

  Click here to expand...

  <name>

  <translation>

  lang_sip_response_code_400 lang_sip_response_code_402 lang_sip_response_code_403 lang_sip_response_code_404 lang_sip_response_code_405 lang_sip_response_code_406 lang_sip_response_code_407 lang_sip_response_code_408 lang_sip_response_code_410 lang_sip_response_code_413 lang_sip_response_code_414 lang_sip_response_code_415 lang_sip_response_code_416 lang_sip_response_code_420 lang_sip_response_code_421 lang_sip_response_code_422 lang_sip_response_code_423 lang_sip_response_code_480 lang_sip_response_code_481 lang_sip_response_code_482 lang_sip_response_code_483 lang_sip_response_code_484 lang_sip_response_code_485 lang_sip_response_code_486 lang_sip_response_code_487 lang_sip_response_code_488 lang_sip_response_code_491 lang_sip_response_code_493 lang_sip_response_code_500 lang_sip_response_code_501 lang_sip_response_code_502 lang_sip_response_code_503 lang_sip_response_code_504 lang_sip_response_code_505 lang_sip_response_code_513 lang_sip_response_code_599 lang_sip_response_code_600 lang_sip_response_code_603 lang_sip_response_code_604 lang_sip_response_code_606

  Bad Request Payment Required Forbidden Not Found Method Not Allowed Not Acceptable Proxy Authentication Required Request Timeout Gone Request Entity Too Large Request-URI Too Long Unsupported Media Type Unsupported URI Scheme Bad Extension Extension Required Session Interval Too Small Interval Too Brief Temporarily Unavailable Call/Transaction Does Not Exist Loop Detected Too Many Hops Address Incomplete Ambiguous Busy Here Request Terminated Not Acceptable Here Request Pending                 Undecipherable                  Server Internal Error           Not Implemented                 Bad Gateway                     Service Unavailable             Server Time-out                 Version Not Supported           Message Too Large               Network Failure Busy Everywhere                 Decline                         Does Not Exist Anywhere Not Acceptable

Example steps

For this example we would like to change the text for SIP error reply 488, from standard text "Not Acceptable Here" to "My Text for 488". Here are the steps to achieve this:

1. You need a working web server. If you don't already have one, install a TFTP or HTTP server.
   If you don't know which TFTP/HTTP server software to take, some ideas: Apache/XAMPP, Lighttpd, SPLiT (https://github.com/pbertera/SPLiT/releases)
   
   
2. Make sure the phone is running firmware version 10.1.41.0 or above
   
   
3. Download the customization file that matches your firmware version and phone, from the Download center which can be found here: Deskphones Firmware
   For this example we used Snom D385 with 10.1.41.0, so we need customization file snomD385-10.1.41.0-customizing.tar.gz
   
   
4. Extract the customization file and look for the GUI language file matching your language in the "snomlang" directory. For this example we used English, so we need file gui_lang_EN.xml
   
   
5. Open gui_lang_EN.xml and scroll down towards the end of the file.
   1.  Look for line: <phrase n="lang_sip_response_code_488" t=""/>
   2. and replace it with: <phrase n="lang_sip_response_code_488" t="My Text for 488"/>
      
      
6. Save your changes to file gui_lang_EN.xml
   
   

7. On your TFTP/HTTP server, under PATH, place your customized file gui_lang_EN.xml and make sure it is reachable under this path (http://SERVER_IP/PATH/gui_lang_EN.xml)
   
   

8. Create intermediary language file gui_lang.xml, which is the container file for the language file/s. This file must look as below, make sure you replace the URL path inside this file with your own HTTP/TFTP link:
   

    Expand source

   <?xml version="1.0" encoding="utf-8" ?>
   <gui-languages>
      <language url="http://SERVER_IP/PATH/gui_lang_EN.xml" name="English" />
   </gui-languages>

   
   

9. Create the initial provisioning file or, if you are already using provisioning, add the following to your existing initial provisioning file:
   

    Expand source

   <setting-files> 
      <file url="http://SERVER_IP/PATH/gui_lang.xml"/>
   </setting-files>
   

    Save the file. Note the name of this file, for this example we will call it settings.xml

   
   
10. Check your files on the web server. You should have at least 3 files now:
    1. initial provisioning file settings.xml (which contains link to intermediary language file)
    2. intermediary language file gui_lang.xml (which contains link to final language file)
    3. final language file gui_lang_EN.xml, where you have done the actual change to the language phrase
       
       
11. On the phone, under Advanced → Update → Setting URL, enter the link to the initial provisioning file (example:  http://SERVER_IP/PATH/settings.xml)
    
    
12. Save and reboot the phone
    
    
13. After the reboot, if you make an outgoing call and receive SIP Error message 488, the phone will show the custom text (Note: 34015 is the called number, it will appear after the custom text):
    
    

• Page:
  <certificates> tag
• Page:
  <dialplan> tag
• Page:
  <functionKeys> tag
• Page:
  <gui-languages>, <web-languages>tag
• Page:
  <phone-settings> tag
• Page:
  <ReplacementPlan> tag
• Page:
  <Setting-Files> tag
• Page:
  <tbook>,<phone-book> tag
• Page:
  <uploads> tag
• Page:
  Action URLs
• Page:
  Ad-Hoc Conference - V10
• Page:
  Auto Provisioning
• Page:
  background_images
• Page:
  Basic setting provisioning via DHCP
• Page:
  BLF - Busy lamp field
• Page:
  Branding Snom Deskphones
• Page:
  Call Features
• Page:
  Call Forwarding
• Page:
  Call Transfer
• Page:
  call_icons