question

Nick R avatar image
Nick R asked Nick R commented

Fax status, how to interpret and how to be sure it is the final one?

Hi!

I have to send faxes through RingCentral for two of the company I work for legacy applications.

For one of them, I have to report back to the applicatiom, using a pretty weird mechanism, if the faxes were sent properly.

Those applications only send faxes to one recipient at a time so it looks like my best bet to get the most precise fax status and error message would be to look at "messageStatus" and "faxErrorCode" under "to".h

I am not sure how to interpret those statuses though and if any of them, besides "Queued" are temporary statuses or final ones...

According to the doc "messageStatus" can take the following values:

Queued, Sent, Delivered, DeliveryFailed, SendingFailed, Received

Now Queued is obviously a temporary status but what about the others. Can the same fax go from DeliveryFailed to Delivered after RingCentral retries to send the faxes.

What about Sent, does it mean the same thing as Delivered or Received?

The doc only seems to mention Queued, SendingFailed and Sent, are the others legacy return codes?

By the way, there seems to be no way to change the number of retries one wants to send a fax, I assume this is setted up by our telephony guy?

Thank you and have a nice day,

Nick



rest api
1 |3000

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Anirban avatar image
Anirban answered

As per this https://www.ringcentral.com/blog/know-fax-transmission-api-succeeded/ :

“Sent” means that message was sent successfully

In general Fax can be viewed in the Service Web Portal (https://service.ringcentral.com) in both Messages > Sent Items and in the Call Log.

If a fax transmission fails, the reason is reported in the Call Log Record's result property. It is also presented in the Service Web Portal. All the Fax question are answered here and the following link will be helpful:

ref: https://forums.developers.ringcentral.com/questions/144/fax-faq.html


As per this link https://ringcentral-faq.readthedocs.io/en/latest/fax/

To resend a fax, call the fax endpoint with the originalMessageId property

You can also use this API for resending and retrying fax and changing the number of retries :

https://developers.ringcentral.com/guide/messaging/fax/resending-faxes

ref: https://forums.developers.ringcentral.com/questions/528/controlling-the-number-of-fax-retries-using-api.html

1 |3000

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Nick R avatar image
Nick R answered

Hi,

I had already read some of the pages you referred me to and unfortunately they (and the new ones you referred me to), do not actually answer my questions. Thank you for your help however...

I must provide to my users the same functionality they had before so asking them to look at a web page on this site to get their fax status and asking them to manually update the fax statuses in our legacy applications is unfortunately out of the question.

By default, how many times does RingCentral try to send a fax before giving up? I doubt it only tries one time and I have to programmatically or manually try to ask for a retry...

Maybe one of the pages you referred me to initially had the answer but one of the links you provided me with (https://ringcentral-faq.readthedocs.io/en/latest/fax/) first link gives me a 404.

(http://success.ringcentral.com/articles/en_US/RC_Knowledge_Article/7027)

Like I said before the 6 statuses are documented but only explanations are only given for like 3 of them, are the others legacy stuff?

Thank you and have a nice day,

Nick

1 |3000

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Phong Vu avatar image
Phong Vu answered Nick R commented

Basically, for outbound fax status, you will receive just the following status:

Queue: your fax is in a queue waiting for to be sending

Sent: You fax has been sent

SendingFailed: Your fax sending failed.

1 comment
1 |3000

Up to 8 attachments (including images) can be used with a maximum of 1.0 MiB each and 10.0 MiB total.

Nick R avatar image Nick R commented ·

Hi Phong!

So the other documented statuses are no longer in use and my code does not need to handle them if I understood you right.

Thank you!

Nick

0 Likes 0 ·

Developer sandbox tools

Using the RingCentral Phone for Desktop, you can dial or receive test calls, send and receive test SMS or Fax messages in your sandbox environment.

Download RingCentral Phone for Desktop:

Tip: switch to the "sandbox mode" before logging in the app:

  • On MacOS: press "fn + command + f2" keys
  • On Windows: press "Ctrl + F2" keys