For a more in depth and other programming language samples, download the Sample Client Install

C# Copy imageCopy
using FaxWSConsoleApplication.FaxWSReference;
using System;
using System.Net;

namespace FaxWSConsoleApplication
{
    public static class GetRealTimeFaxStatusExClass
    {
        const string oauthUrl = "https://login.concord.net/v1/connect/token";
        const string faxWSUrl = "https://ws.concordfax.com/fax/v5";

        public static void GetRealTimeFaxStatusEx()
        {
            string username = "mbxXXXXXXXX"; // Fax Broadcast Account Id
            string password = "XXXX";
            WSError wsError = null;

            ///////////////////////////////////////////////////////////
            ///OAuth 2.0 Authentication Start, 
            ///Comment this block out if you are using username and password authentication
            // Get an access token from Concord Identity Server
            string grantType = "password";
            string scope = "FaxWS";
            string faxWSClientId = "A9F528F9-0000-4B70-0000-078C23030424-ConcordApiFaxWS";
            string faxWSClientSecret = "";

            AccessTokenRequest accessTokenRequest = null;
            AccessTokenResponse accessTokenResponse = null;
            TokenManager tokenManager = new TokenManager(oauthUrl);

            accessTokenRequest = new AccessTokenRequest(
                clientId: faxWSClientId,
                clientSecret: faxWSClientSecret,
                username: username,
                password: password,
                grantType: grantType,
                scope: scope,
                redirectUri: null,
                code: null,
                refreshToken: null,
                state: null);

            ///OAuth 2.0 Authentication End
            ///////////////////////////////////////////////////////////

            using(FaxWSAuthWrapper ws = new FaxWSAuthWrapper())
            {
                ws.Url = faxWSUrl;

                FaxJobId[] FaxJobIds = new FaxJobId[1];
                FaxJobIds[0] = new FaxJobId();
                FaxJobIds[0].JobId = "brxxxxxxxxxx"; // Job id to request status for

                RealTimeFaxStatusEx[] realTimeFaxStatusList = null;

                try
                {
                    // Get an access token from Cache OR request one from the Identity Server
                    accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest);

                    if(accessTokenResponse == null)
                    {
                        Console.WriteLine("Failed to get an AccessToken, returned null");

                        return;
                    }

                    // Check to see if we failed to get an Access token via a Refresh token that has expired or been revoked, if so we need to re-authenticate
                    if(accessTokenResponse.HttpStatusCode == HttpStatusCode.BadRequest && accessTokenResponse.Error == "invalid_grant")
                    {
                        Console.WriteLine("Refresh token expired, attempting to get a new Access Token");
                        accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest, ignoreCache: true);
                    }

                    if(accessTokenResponse.HttpStatusCode != HttpStatusCode.OK)
                    {
                        Console.WriteLine("AccessToken not valid, Error Code: {0}, Error Description: {1}", accessTokenResponse.Error, accessTokenResponse.ErrorDescription);

                        return;
                    }

                    // User Name and Password authentication
                    //if (ws.GetRealTimeFaxStatusEx(username, password, FaxJobIds, out realTimeFaxStatusList, out wsError))

                    // OAuth 2.0 Authentication requires that you pass in an access token as part of the Authorization: header 
                    // (No Password required)

                    ws.AccessToken = accessTokenResponse.AccessToken;

                    if(!ws.GetRealTimeFaxStatusEx(username, "", FaxJobIds, out realTimeFaxStatusList, out wsError))
                    {
                        Console.WriteLine("GetRealTimeFaxStatusEx Failed");

                        Console.WriteLine("Error Code: {0} Error Description: {1}", wsError.ErrorCode, wsError.ErrorString);

                        // Check to see if response indicates access token has expired, if so attempt to Refresh or Get New OAuth access token and try method call again
                        if(wsError.ErrorCode == -5059)
                        {
                            Console.WriteLine("AccessToken is not valid");

                            // Attempt to get a new access token or use a refresh token, if we fail we should stop
                            accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest);

                            if(accessTokenResponse == null)
                            {
                                Console.WriteLine("Failed to get an AccessToken, returned null");

                                return;
                            }

                            if(accessTokenResponse.HttpStatusCode != HttpStatusCode.OK)
                            {
                                Console.WriteLine("AccessToken not valid, Error Code: {0}, Error Description: {1}", accessTokenResponse.Error, accessTokenResponse.ErrorDescription);

                                return;
                            }
                        }

                        return;
                    }

                    foreach(RealTimeFaxStatusEx realTimeFaxStatus in realTimeFaxStatusList)
                    {
                        Console.WriteLine("Real Time Fax Status");
                        Console.WriteLine("Error Code: " + realTimeFaxStatus.Error.ErrorCode);
                        Console.WriteLine("Error Description: " + realTimeFaxStatus.Error.ErrorString);
                        Console.WriteLine("Fax Delivery Date Time: " + realTimeFaxStatus.FaxDeliveryDateTime);
                        Console.WriteLine("Fax Delivery Duration: " + realTimeFaxStatus.FaxDeliveryDuration);
                        Console.WriteLine("Fax Job ID: " + realTimeFaxStatus.FaxJobId);
                        Console.WriteLine("Fax Job Status ID: " + realTimeFaxStatus.FaxJobStatusId);
                        Console.WriteLine("Recipient Current Page Count: " + realTimeFaxStatus.RecipientCurrentPageCount);
                        Console.WriteLine("Recipient State: " + realTimeFaxStatus.RecipientState);
                        Console.WriteLine("Recipient Total Page Count: " + realTimeFaxStatus.RecipientTotalPageCount);
                        Console.WriteLine("RemoteFaxCSID: " + realTimeFaxStatus.RemoteFaxCSID);
                        Console.WriteLine("Status Description: " + realTimeFaxStatus.StatusDescription);
                    }

                }
                catch(Exception ex)
                {
                    Console.WriteLine("Error while calling GetRealTimeFaxStatusEx : " + ex.Message);
                }

            }
        }

    }
}
Visual Basic Copy imageCopy
Imports System.Net
Imports FaxWSVBConsoleApplication.FaxWSReference

Namespace FaxWSVBConsoleApplication
    Friend Class GetRealTimeFaxStatusExClass
        Public Shared Sub GetRealTimeFaxStatusEx()
            Dim username As String = "mbxXXXXXXXX" ' Fax Broadcast Account Id
            Dim password As String = "XXXX"
            Dim wsError As WSError = Nothing

            ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
            '' OAuth 2.0 Authentication Start, 
            '' Comment this block out if you are using username and password authentication
            ' Get an access token from Concord Identity Server

            Dim oauthUrl As String = "https://login.concord.net/v1/connect/token"
            Dim grantType As String = "password"
            Dim scope As String = "FaxWS"
            Dim faxWSClientId As String = "A9F528F9-0000-4B70-0000-078C23030424-ConcordApiFaxWS"
            Dim faxWSClientSecret As String = ""
            Dim accessTokenRequest As AccessTokenRequest = Nothing
            Dim accessTokenResponse As AccessTokenResponse = Nothing
            Dim tokenManager As TokenManager = New TokenManager(oauthUrl)
            accessTokenRequest = New AccessTokenRequest(clientId:=faxWSClientId, clientSecret:=faxWSClientSecret, username:=username, password:=password, grantType:=grantType, scope:=scope, redirectUri:=Nothing, code:=Nothing, refreshToken:=Nothing, state:=Nothing)


            '' OAuth 2.0 Authentication End
            ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

            Using ws As FaxWSAuthWrapper = New FaxWSAuthWrapper()
                Dim FaxJobIds As FaxJobId() = New FaxJobId(0) {}
                FaxJobIds(0) = New FaxJobId()
                FaxJobIds(0).JobId = "brxxxxxxxxxx" ' Job id to request status for
                Dim realTimeFaxStatusList As RealTimeFaxStatusEx() = Nothing

                Try
                    ' Get an access token from Cache OR request one from the Identity Server
                    accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest)

                    If accessTokenResponse Is Nothing Then
                        Console.WriteLine("Failed to get an AccessToken, returned null")
                        Return
                    End If


                    ' Check to see if we failed to get an Access token via a Refresh token that has expired or been revoked, if so we need to re-authenticate
                    If accessTokenResponse.HttpStatusCode = HttpStatusCode.BadRequest AndAlso Equals(accessTokenResponse.Error, "invalid_grant") Then
                        Console.WriteLine("Refresh token expired, attempting to get a new Access Token")
                        accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest, ignoreCache:=True)
                    End If

                    If accessTokenResponse.HttpStatusCode <> HttpStatusCode.OK Then
                        Console.WriteLine("AccessToken not valid, Error Code: {0}, Error Description: {1}", accessTokenResponse.Error, accessTokenResponse.ErrorDescription)
                        Return
                    End If


                    ' User Name and Password authentication
                    'if (ws.GetRealTimeFaxStatusEx(username, password, FaxJobIds, out realTimeFaxStatusList, out wsError))

                    ' OAuth 2.0 Authentication requires that you pass in an access token as part of the Authorization: header 
                    ' (No Password required)

                    ws.AccessToken = accessTokenResponse.AccessToken

                    If Not ws.GetRealTimeFaxStatusEx(username, "", FaxJobIds, realTimeFaxStatusList, wsError) Then
                        Console.WriteLine("GetRealTimeFaxStatusEx Failed")
                        Console.WriteLine("Error Code: {0} Error Description: {1}", wsError.ErrorCode, wsError.ErrorString)


                        ' Check to see if response indicates access token has expired, if so attempt to Refresh or Get New OAuth access token and try method call again
                        If wsError.ErrorCode = -5059 Then
                            Console.WriteLine("AccessToken is not valid")

                            ' Attempt to get a new access token or use a refresh token, if we fail we should stop
                            accessTokenResponse = tokenManager.GetAccessToken(accessTokenRequest)

                            If accessTokenResponse Is Nothing Then
                                Console.WriteLine("Failed to get an AccessToken, returned null")
                                Return
                            End If

                            If accessTokenResponse.HttpStatusCode <> HttpStatusCode.OK Then
                                Console.WriteLine("AccessToken not valid, Error Code: {0}, Error Description: {1}", accessTokenResponse.Error, accessTokenResponse.ErrorDescription)
                                Return
                            End If
                        End If

                        Return
                    End If

                    For Each realTimeFaxStatus As RealTimeFaxStatusEx In realTimeFaxStatusList
                        Console.WriteLine("Real Time Fax Status")
                        Console.WriteLine("Error Code: " & realTimeFaxStatus.Error.ErrorCode)
                        Console.WriteLine("Error Description: " & realTimeFaxStatus.Error.ErrorString)
                        Console.WriteLine("Fax Delivery Date Time: " & realTimeFaxStatus.FaxDeliveryDateTime)
                        Console.WriteLine("Fax Delivery Duration: " & realTimeFaxStatus.FaxDeliveryDuration)
                        Console.WriteLine("Fax Job ID: " & realTimeFaxStatus.FaxJobId)
                        Console.WriteLine("Fax Job Status ID: " & realTimeFaxStatus.FaxJobStatusId)
                        Console.WriteLine("Recipient Current Page Count: " & realTimeFaxStatus.RecipientCurrentPageCount)
                        Console.WriteLine("Recipient State: " & realTimeFaxStatus.RecipientState)
                        Console.WriteLine("Recipient Total Page Count: " & realTimeFaxStatus.RecipientTotalPageCount)
                        Console.WriteLine("RemoteFaxCSID: " & realTimeFaxStatus.RemoteFaxCSID)
                        Console.WriteLine("Status Description: " & realTimeFaxStatus.StatusDescription)
                    Next

                Catch ex As Exception
                    Console.WriteLine("Error while calling GetRealTimeFaxStatusEx : " & ex.Message)
                    Return
                End Try
            End Using
        End Sub
    End Class
End Namespace

See Also