IMG 1010 - Downloading a Raw File

A raw API file should be plain text file with hex values in ASCII format. The line ending in a raw API file must be <CR><LF> (Windows format) and not only <LF> (Linux format and others) as this will not be accepted.

Dynamic

To download API messages for a one-time execution:

  • If the raw API file you require is for a ringback tone definition in a specific country, refer to the following Tech Note at: Country specific ringback tones . For any other raw API files, contact Sangoma Technical Support and they can create the file with the raw API messages.

  • Load the file into the following location on the GCEMS server: /opt/dialogic/common/config (Software 10.5.1+)  or /opt/cantata/common/config/  (Software 10.5.0)  

  • Select the Physical IMG to which you want to download the file by clicking on it.

  • Click the Download Raw File button located below the Physical IMG object Pane. This will send the file to the Physical IMG selected.

Note: If the messages in the rawapi.cfg file have a different logical node ID than the physical IMG from which the button is pressed, the node ID will be overwritten in the file. This allows sending the same file for multiple nodes without needing to modify its contents. If a message in the file is NACKed by the IMG, all the subsequent messages will be not be sent.

Static

To download API messages and have them become part of the config file:

  • Create a raw hex file or files and save as "*.hex" to the following folder: /opt/dialogic/common/config/

  • Right-click the Physical IMG entry and select New Raw API Cmds.

  • Right-click Raw API Cmds and select New Raw API Cmd.

  • The Raw API Cmd pane appears.


    The Configure File field is automatically populated with all *.hex files.  

  • To send the file to the IMG, right-click Raw API Cmds and select Send Raw API.

  • See the IMG 1010 - Raw API Command pane reference for details.

Return to Documentation Home I Return to Sangoma Support