This function can be used to request status of a fax broadcast using the job ID string. The out parameter contains error information (if the job status failed). This function requires a fax broadcast account.

Syntax

C# Copy imageCopy
bool GetFaxBroadcastStatus(
    string UserID,
    string strPIN,
    FaxBroadcastStatusRequest request,
    out RecipientStatus[] RecipientStatusList,
    out WSError WSError
)
Visual Basic Copy imageCopy
GetFaxBroadcastStatus(
    ByVal UserID As String,
    ByVal strPIN As String,
    ByVal request As FaxBroadcastStatusRequest,
    ByRef RecipientStatusList() As RecipientStatus,
    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

request

FaxBroadcastStatusRequest

Required

See FaxBroadcastStatusRequest for details.

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

StatusList

RecipientStatus[]

Returns a list of RecipientStatus.

WSError

WSError

Return Error details.

Result

return

Boolean

True/False indicating result of method call

Code Examples

Detailed code examples for GetFaxBroadcastStatus method

See Also