Phone Lines icon GFI Support

Articles in this section

See more

Supported SMS Fields and Parameters in GFI FaxMaker

Author: Shera Matig-a Updated

Information

This article details the supported SMS fields and parameters in GFI FaxMaker, particularly:

For more information, see the article: Sample XMLAPI's for Fax and SMS

Message Fields

In the <fields> container, specify the following information:

SMS Message XML Path \faxmakerdata\fields\bodyfile
Type Full path or filename
Disposition Required
Details

Uses the contents of the file as the SMS message.

Key in the full path of the file.

Specify the file type:

  • type="text/html" - message body text is in HTML format.
  • type="text/rtf" - message body text is in RTF format.
  • type="text/plain" - message body text is in plain text format.

If no file type attribute is specified, the message is processed as plain text.
Example <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
SMS Line XML Path \faxmakerdata\fields\gsmline
Type Number (COM Port) or String (name configured for GSM line)
Disposition Optional
Details

Request an SMS to be sent on a particular GSM line. Specify the name or the COM Port number as configured in GFI FaxMaker. For more information, refer to Configuring SMS Gateway Settings for GSM Device in GFI FaxMaker

Use the demandline parameter to specify how to send the SMS if the specified line is busy or does not exist. Use demandline=”true” to send the SMS strictly from the specified GSM line. Use demandline=”false” to send the SMS via the next available GSM line if the specified line is busy or does not exist.
Example <gsmline demandline="true">3</gsmline>

or

<gsmline demandline="false">MyGSMline</gsmline>

Back to top

Sender Fields

In the <sender> container, specify the sender information as follows:

First Name XML Path \faxmakerdata\sender\firstname
Type String
Disposition Optional
Details Sets the first name of the sender.
Example <firstname>John</firstname>
Last Name XML Path \faxmakerdata\sender\lastname
Type String
Disposition Optional
Details Sets the last name of the sender.
Example <lastname>Smith</lastname>
Company XML Path \faxmakerdata\sender\company
Type String
Disposition Optional
Details Sets the company name of the sender.
Example <company>MyCompany Name</company>
Department XML Path \faxmakerdata\sender\department
Type String
Disposition Optional
Details Sets the department of the sender.
Example <department>Sales</department>
Phone Number XML Path \faxmakerdata\sender\voicenumber
Type String
Disposition Optional
Details Sets the voice (phone) number of the sender.
Example <voicenumber>+1(800)1234 5678</voicenumber>
Email Address XML Path \faxmakerdata\sender\emailaddress
Type String
Disposition Required
Details Sets the email address of the sender.
Example <emailaddress>jsmith@mydomain.com</emailaddress>

Back to top

SMS Recipient Fields

In the <recipient> container, specify the recipient information. For SMS, add a <sms> container and a <recipient> container.

For example:

<recipients>

   <sms>

      <recipient>

         <smsnumber>+1 800 1234 5678</smsnumber>

      </recipient>

    </sms>

</recipients>

Insert other parameters and fields in the <recipient> container as follows:

First Name XML Path \faxmakerdata\recipients\sms\recipient\firstname
Type String
Disposition Optional
Details Sets the first name of the recipient.
Example <firstname>Joe</firstname>
Last Name XML Path \faxmakerdata\recipients\sms\recipient\lastname
Type String
Disposition Optional
Details Sets the last name of the recipient.
Example <lastname>Bloggs</lastname>
Company XML Path \faxmakerdata\recipients\sms\recipient\company
Type String
Disposition Optional
Details Sets the company name of the recipient.
Example <company>SMSRecipient Company Ltd.</company>
Department XML Path \faxmakerdata\recipients\sms\recipient\department
Type String
Disposition Optional
Details Sets the department of the recipient.
Example <department>Marketing</department>
SMS Number XML Path \faxmakerdata\recipients\sms\recipient\smsnumber
Type String
Disposition Required
Details Sets the SMS number of the recipient.
Example <smsnumber>+1(800)8765 4321</smsnumber>
Voice Number XML Path \faxmakerdata\recipients\sms\recipient\voicenumber
Type String
Disposition Optional
Details Sets the telephone (voice) number of the recipient.
Example <voicenumber>+1(800)8765 4444</voicenumber>
Email Address XML Path \faxmakerdata\recipients\sms\recipient\emailaddress
Type String
Disposition Optional
Details Sets the email address of the recipient.
Example <emailaddress>John@smsrecipientdomain.com</emailaddress>

Back to top

Sending an SMS to Multiple Recipients

An SMS can be sent to multiple recipients. To perform this, add multiple <recipient>...</recipient> containers.
For example:

<recipients>

   <sms>

      <recipient>

         <firstname>John</firstname>

         <smsnumber>+1 800 1111 1111</smsnumber>

      </recipient>

      <recipient>

         <firstname>Bob</firstname>

         <smsnumber>+1 800 2222 2222</smsnumber>

      </recipient>

    </sms>

</recipients>

Back to top

Related Articles