ClickCease

API PARAMETERS AND RETURN VALUES [DECODED]

Unless you are deep diving into the SDK you may miss some of the enum values that are useful for implementing the API. What are Enums? Basically they are a list of values that can be used as an input value for a web service or they are presented as output values. If you need to trap a particular output or status these values are key for proper error trapping and flow in your application.

We’ll look at the most frequently used API calls and break down the values allowed and returned. Is there another API call you want documentation for or need to know more? Let us know.

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

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: {
        Success,
        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
January 23, 2020 /