API Values and Return Parameters [DECODED]

This reference decodes the enum values — the fixed lists of input and output values a web service accepts or returns — for the most-used WestFax API calls: Fax_SendFax, Fax_GetFaxDescriptionsUsingIds, Fax_GetFaxIdentifiers, Fax_GetFaxDocuments, Fax_ChangeFaxFilterValue, and Fax_GetProductsWithInboundFaxes. Unless you’re deep-diving into the SDK, it’s easy to miss which values a field like FaxQuality or Success actually expects or returns. Each entry below lists the accepted input parameters and the possible output values, including the ErrorString and InfoString fields the API returns on a failed call, so you can build reliable error trapping and control flow into your integration instead of guessing at valid inputs through trial and error.

Have a question about a call that isn’t covered here? Let us know and we’ll add it.

Fax_SendFax

Input Parameters

• FaxQuality - Fine or Normal

Ouput Values

• Success - True or False
• Result - 0000000-0000-0000-0000 {JobId} or if failed it will return an ErrorString and InfoString which will have detailed failure information

For the full parameter list and a walkthrough of a live call, see our Fax_SendFax breakdown.

Fax_GetFaxDescriptionsUsingIds

Input Parameters

• FaxIds1..3

  
  
          {
  
              "Id": "28887ac4-424d-4164-9def-ca5e926342d8",
  
              "Direction": "Outbound"
  
          }
  
                                      

  Include the jobId and the Direction which can be Inbound or Outbound

Output Values

• Success - True or False

• Result - Can be a JSON Object

  
  
          {
  
              "Success": true,
  
              "Result": [{
  
                  "FaxCallInfoList": [{
  
                      "CallId": "00000-00000-000000-0000",
  
                      "CompletedUTC": "2019-12-05T15:11:06Z",
  
                      "TermNumber": "000000000",
  
                      "OrigNumber": "2225551212",
  
                      "OrigCSID": "(222) 555-1212",
  
                      "Result": "NoAnswer"
  
                  }],
  
              "Id": "00000-00000-000000-0000",
  
              "Date": "2019-12-05T15:11:33Z",
  
              "Direction": "Outbound",
  
              "Tag": "Retrieved",
  
              "PageCount": 1,
  
              "FaxQuality": "Normal",
  
              "Status": "Complete"
  
              }]
  
          }
  
              
  
          Result can be: {
  
              Sent,
  
              Dialing,
  
              Removed,
  
              BadNumber,
  
              Busy,
  
              NoAnswer,
  
              NoFaxDevice,
  
              Cancelled,
  
              Failed,
  
              InvalidNumber,
  
              Unknown
  
          }
  
                                      

Fax_GetFaxIdentifiers

Input Parameters

• FaxDirection - Inbound or Outbound>

Output Values

• "Success": true,
• "Result":

  
  
          [
  
              {
  
                  "Id": "000000-00000-00000-000000",
  
                  "Direction": "Inbound",
  
                  "Date": "2020-01-23T21:24:50Z",
  
                  "Tag": "None"
  
              },
  
              {
  
                  "Id": "000000-00000-00000-000000",
  
                  "Direction": "Inbound",
  
                  "Date": "2020-01-23T21:24:50Z",
  
                  "Tag": "None"
  
              }
  
          ]
  
                                  

Fax_GetFaxDocuments

Input Parameters

• FaxIds1..3

  
  
          {
  
              "Id": "28887ac4-424d-4164-9def-ca5e926342d8",
  
              "Direction": "Outbound"
  
          }
  
                                      

  Include the jobId and the Direction which can be Inbound or Outbound

Output Values

• 
  
          {
  
              "Success":true,
  
              "Result": [{
  
                  "FaxFiles":[{
  
                      "ContentType":"application/pdf",
  
                      "ContentLength":35586,
  
                      "FileContents":"JVBERi0xLjINCgolJUVPRg0K..."
  
                  }],
  
                  "Id":"0000000-0000-0000-0000000000",
  
                  "Direction":"Inbound",
  
                  "Date":"2020-01-23T21:24:50Z",
  
                  "Status":"Ok",
  
                  "Format":"pdf",
  
                  "PageCount":1
  
              }]
  
          }
  
                                  

Fax_ChangeFaxFilterValue

Input Parameters

• FaxIds1..3

  
  
          Must be in JSON:
  
          {
  
              "Id": "0000000-00000-000000-000000000"
  
          }
  
                                      

• Filter: is what we are changing the specified fax status to:
  • None (reset - marked as unread)
  • Retrieved (Marked as read)
  • Removed (Deleted)

  Output Values

  
  
          {
  
              "Success": true,
  
              "Result": true
  
          }
  
                                  

  Fax_GetProductsWithInboundFaxes

  Input Parameters

  • Filter:
    • None
    • Retrieved
    • Removed

    Output Values

    • None