This function can be used to query the real time status (including pages sent if job is in progress) of multiple previously submitted fax jobs using the job ID string. The out parameters contain the real time fax status array (one per Job ID) and error information (if the job submission failed). If the request is sent after the job has been delivered it also returns fax call duration, delivery date/time and remote fax CSID. This function requires a Fax Online or Fax Pro(100/300/1000) Account.

Syntax

C# Copy imageCopy
bool GetRealTimeFaxStatusEx(
    string UserID,
    string strPIN,
    FaxJobId[] FaxJobIds,
    out RealTimeFaxStatusEx[] FaxStatusList,
    out WSError WSError
)
Visual Basic Copy imageCopy
GetRealTimeFaxStatusEx(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal FaxJobIds() As FaxJobId,
    ByRef FaxStatusList() As RealTimeFaxStatusEx,
    ByRef WSError As WSError
) As Boolean

Parameters

Parameter

Type

Required?

Description

Input Header

Authorization

String

Required for OAuth 2.0 authorization

A string representing the authentication of the request via an access token in the format of Authorization: Bearer {AccessToken}.

Example: Authorization: Bearer M1Q0NjJvZ7Q5OPM2NDW1ZTCjOGZmYjI4

x-ch-request-id

String

Client generated unique identifier for tracking

Content-Type

String

Indicates the expected content type of the payload. Valid options are:

  • application/soap+xml for SOAP XML.

  • application/json for JSON.

If a value is not supplied then the default of application/soap+xml is used.

Input Body

UserID

String

Required

String representing the API Service User Id. Example: mbx1234567890

strPIN

String

Required for username and password authentication

Deprecated. Use OAuth 2.0 and Authorization header for modern authentication

FaxJobIds

FaxJobId[]

Required

Array of FaxJobId to request status for.

Output Header

x-ch-activity-id

String

Server generated unique identifier of tracking

x-ch-execution-time

String

Server execution time in milli-seconds

Output Body

FaxStatusList

RealTimeFaxStatusEx[]

Return array with results for each requested FaxJobId.

WSError

WSError

Return error details.

Result

return

Boolean

True/False indicating result of method call

Remarks

  • While requesting status for jobs, the user can either specify the Concord Job Id which is returned as part of job send responses (In ‘brxxxx’ format) or the customer specified ReferenceId prefixed with ‘JRI-’ (‘JRI-ReferenceId’). if the user is planning to use ReferenceId as a way to identify a specific job, The user need to ensure the uniqueness of the ReferenceId (Customer provided Identifier) while submitting the fax requests. Otherwise the most recent job with the given Reference Id will be returned.

Code Examples

Detailed code examples for GetRealTimeFaxStatusEx method

See Also