This interface is provided for the CellTrust SMS service. This document is subject to change.
The interface can be configured either to use the Copia account at CellTrust or to work with a separate customer account. It currently supports only standard SMS messages, not CellTrust Secure SMS messages.
The following parameters are available:
|$sms_service||The name of the DLL for this interface should be entered on the second parameter of the $sms_service command as "@PFC\CF8SMS01.DLL". For example:|
$sms_service * CELLTRUST "@PFC\CF8SMS01.DLL"
|SMS_SERVICE||Set this variable to CELLTRUST (see above) to use this service for the call.|
|SMS01_USERNAME||Set this variable in FAXFACTS.CFG to your own CellTrust user name if not using the Copia account.|
|SMS01_PASSWORD||Set this variable in FAXFACTS.CFG to your own CellTrust password if not using the Copia account.|
|SMS01_NICKNAME||Set this variable to the Nickname to be used for the message. If not supplied the username will be used.|
|SMS_ENCODING||Set this variable in FAXFACTS.CFG to UTF8 or UNICODE if your own CellTrust account is so configured. Do not use this variable with the Copia account, which is not configured for Unicode messages. The use of Unicode is not recommended with CopiaFacts release 7.x.|
|SMS01_SHORTCODE||Specifies the short code to be used to deliver the message, if used|
|SMS_MSGID||The message ID returned by CellTrust will be saved in this variable. This variable is not set if the submission fails. When the PENDING FS is resubmitted to get a delivery report, this variable is used to identify the item.|
SMS_DELIVERY_OUTCOME Will be set to PENDING after the 'submission' of the message. This variable is not set if the submission fails.
|SMS_ERROR_CODE||Will be set to the numeric code returned by CellTrust if the message submission fails. Code list to follow.|
SMS_ERROR_MESSAGE Will be set to the error description returned by CellTrust if the message submission fails.
SMS_DELIVERY_OUTCOME Will be set to SUCCESS, FAILURE or UNDELIVERABLE after the delivery report has been received. Will be left at PENDING if the delivery report could not be obtained or if the delivery report is ENROUTE.
SMS_REPORT_ERROR_CODE Will be set to the numeric code returned by CellTrust if the message delivery report could not be obtained. Code list to follow.
SMS_REPORT_ERROR_MESSAGE Will be set to the failure description returned by CellTrust if the message delivery could not be obtained.
SMS_REPORT_ERROR_CODE Will be set to the numeric code returned by CellTrust if the report collection fails. Code list to follow.
SMS_FAILURE_REASON Will be set to the error description returned by CellTrust if the delivery outcome was FAILURE or UNDELIVERABLE.
|Outcome codes||One of the following codes:|
|170 SMS_SERVICE not defined for the transmission|
|171 Inconsistent value in SMS_DELIVERY_OUTCOME|
|172 Submission error (message or delivery report)|
|173 Error getting SMS provider response|
|FFTRACE||Set CF8SMS01 under File/Applications to see the trace output.|