XMFax Cloud - Error code 600/602

mg2025
mg2025 Member
in XM Fax #1

When attempting to get the status of a fax that failed using the broadcast ID, it appears the same as if the fax is still waiting to be sent. It does not provide the error code that is visible in the XMFax Portal.

Steps to reproduce:

  1. We sent a fax to a phone number (intentionally to check behavior; sometimes we are given a wrong number!)
  2. The fax transmission failed, showing as Error: 600 in the XMFax Portal's outbound faxes history.
  3. In the Event Log for the failed fax, an entry shows Fax Transmission Failure with error code 602. (Neither 600 nor 602 error codes appear in your documentation.)
  4. We tried to check the status of the outbound fax using the Broadcast ID, via findOutboundFaxesAdvanced.

Result: The findOutboundFaxesAdvancedResponse object returns totalItems=0.

Perhaps we are misunderstanding the BroadcastId vs FaxId, is there documentation on the difference? What is the recommended way to check the status of a sent fax?

The documentation (Find a fax | Get Started with XM Fax Cloud SOAP Web Services | Developer | OpenText ) only shows how to get the status of an Inbound fax, is there documentation on the "right" way to get the status of a fax by broadcast ID?

Can you also clarify the error codes 600 and 602, which are not listed here in the documentation? XM Fax Web Service: com.faxserver.xm.ws.FaxException Class Reference 

Best Answer

  • LaurenceLabonté
    LaurenceLabonté E Community Moderator
    #2 Answer ✓

    Without the exact request made to get the findOutboundFaxesAdvanced it's hard to know what part didn't work. Since the request didn't returned any faxes, it's most likely that the search parameter are wrong.

    The Postman collection (https://github.com/opentext/XM-Fax/tree/main/Postman) show example for parameter for that method (and the expected format for each).

    The broadcastID is the ID (similar to D7E0953F-CD2F-4F3E-B7D5-5BB306998E1D-620-BR) of the full broadcast. It's returned by sendFax method (and available in the portal).
    The faxID is used when querying or making action on a specific fax. It's returned by the findInbound/Outbound methods and used when asked for a parameter named faxId.

    For the error code, there is two type in the Webservice. The one linked above, is if the soap request was not completed correcly. It will be inside a FaxException, in the property "code" when receiving a 500 http error code.
    For the error code of a specific fax, in the api, once your findOutboundFaxesAdvanced return the expected list of fax, you will get 3 property: errorCode, errorDescription and adminErrorCode that should contain info to help categorize it. The administrator portal view of the fax also contain more information about that error (enterprise → Core Fax → Monitor → Outbound history → specific fax → Fax properties → Error Code property → More). This will shown the advanced meaning of the error.

    I've entered an internal request to have a better documented list of all error codes for a outbound fax.

Answers

  • LaurenceLabonté
    LaurenceLabonté E Community Moderator
    #3 Answer ✓

    Without the exact request made to get the findOutboundFaxesAdvanced it's hard to know what part didn't work. Since the request didn't returned any faxes, it's most likely that the search parameter are wrong.

    The Postman collection (https://github.com/opentext/XM-Fax/tree/main/Postman) show example for parameter for that method (and the expected format for each).

    The broadcastID is the ID (similar to D7E0953F-CD2F-4F3E-B7D5-5BB306998E1D-620-BR) of the full broadcast. It's returned by sendFax method (and available in the portal).
    The faxID is used when querying or making action on a specific fax. It's returned by the findInbound/Outbound methods and used when asked for a parameter named faxId.

    For the error code, there is two type in the Webservice. The one linked above, is if the soap request was not completed correcly. It will be inside a FaxException, in the property "code" when receiving a 500 http error code.
    For the error code of a specific fax, in the api, once your findOutboundFaxesAdvanced return the expected list of fax, you will get 3 property: errorCode, errorDescription and adminErrorCode that should contain info to help categorize it. The administrator portal view of the fax also contain more information about that error (enterprise → Core Fax → Monitor → Outbound history → specific fax → Fax properties → Error Code property → More). This will shown the advanced meaning of the error.

    I've entered an internal request to have a better documented list of all error codes for a outbound fax.

  • mg2025
    mg2025 Member
    #4

    Thanks LaurenceLabonte.

    We have the Postman collection and were able to replicate the behavior using that suite as well. After 20-30 minutes, the findOutboundFaxesAdvanced endpoint did start returning a result with the failed fax code. We will train our users on that expectation.

    Perhaps it would be useful to have some clarification regarding what the faxID represents vs. the broadcastID, and which one to use in which scenarios.

    Another OpenText guru suggested using two different endpoints — findOutgoingFaxesAdvanced to see where the item is in the queue, and then findOutboundFaxesAdvanced to get the final status. While I appreciate those separations of concerns, we were expecting to see one endpoint that allows checking the status of a request regardless of queue/sent/failed status to reduce chattiness and manage complexity.

    Thanks for letting us know where to find the error codes!

  • Unknown
    Unknown
    #5
    This content has been removed.

Categories