MESSAGE_COMPLETION_CODE_STRING

The MESSAGE_COMPLETION_CODE_STRING string tag appears in message taglists returned from the GET_Q_ENTRIES_INFO function. This tag contains a string value that indicates the general status of a message, as derived from a message's MESSAGE_COMPLETION_CODE tag. Note that for sent faxes, an "Unsustainable connection" suggests an error condition that may be temporary, where the message might succeed on a subsequent attempt.

The MESSAGE_COMPLETION_CODE_STRING tag can be set to one of the following values:

	"Ok"		No error
	"Busy"		Phone line was busy
	"No Answer"		Phone line was not answered
	"No Dial Tone (phone cord disconnected)"		No Dial Tone was detected
	"Unsustainable connection"		A fax connection was established, but then could not be sustained
	"Incompatible fax device"		A fax connection could not be established

Type

Max Size

Multiple Allowed

String

N/A

Yes, one per MESSAGE_HANDLE sub-section

Example:

function GetAllSentMessageStatus()
{
var Tl, Sl;
var Msg = "";

Tl = CAS.New();
CAS.AddTag(Tl,"GET_Q_ENTRIES_INFO","");
CAS.AddTag(Tl,"REGISTERED_NAME","Fred");
CAS.AddTag(Tl,"REGISTERED_PASSWORD","");
CAS.AddTag(Tl,"Q_ID","Q_ID_SENT");

Sl = CAS.CreateSection(Tl,"RESPONSE_INCLUDE_ONLY","");
   CAS.AddTag(Sl,"MESSAGE_COMPLETION_CODE","");
   CAS.AddTag(Sl,"MESSAGE_COMPLETION_CODE_STRING","");
CAS.CloseSection(Sl);

    // Get messages on this already open session
Tl = CAS.Send(Instance,Tl);

if ( CAS.GetTag(Tl,"STATUS_NUM",0) == 0 )
    {
      // The number of messages is in the root of the reply taglist
    QueueCount = CAS.GetTag(Tl,"NUMBER_OF_Q_ENTRIES",0);

      // Each message is in it's own sub-section
    for ( a = 0; a < QueueCount; a++)
      {
      Sl = CAS.OpenSection(Tl,"MESSAGE_HANDLE[" + a + "]");
        Msg += CAS.GetTag(Sl,"MESSAGE_HANDLE",0) + ",";
        Msg += CAS.GetTag(Sl,"MESSAGE_COMPLETION_CODE",0) + ",";
        Msg += CAS.GetTag(Sl,"MESSAGE_COMPLETION_CODE_STRING",0);
        Msg += "\r\n";
      CAS.CloseSection(Sl);
      }
    }
else
    {
      // Return the error
    Msg = CAS.GetTag(Tl,"STATUS",0);
    }

CAS.Delete(Tl);

return(Msg);
}

See Also:

GET_Q_ENTRIES_INFO, MESSAGE_COMPLETION_CODE