Skip to main content
Question

Unable to see faxes that were not sent.


Forum|alt.badge.img

I recently conducted a test by sending a fax using the following RingCentral API endpoint:
https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~/message-store.

In this instance, I mistakenly used an incorrect fax number. I was expecting to see a "Failed" status for the fax, but I am currently only able to view faxes marked as "Sent." Could you kindly guide me on how to retrieve the status of failed faxes or direct me to the appropriate method for monitoring this?

Thank you for your assistance.

11 replies

PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 21, 2024

If sending a fax fails, the fax message status will be 'SendingFailed'. The failed fax message should be still in the user message store. Make sure that you authenticate your app with the same user, or if you read the message store of other users (as a super admin user) you need to specify the correct user id in the API path.


Forum|alt.badge.img
  • Author
  • Participating Frequently
  • 5 replies
  • October 21, 2024

What is the best way to go about checking if messages were sent, or failed? I am using rest API 


PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 21, 2024

After sending a (Fax) message, grab the message id from the API response and call this API to check the status.


Forum|alt.badge.img
  • Author
  • Participating Frequently
  • 5 replies
  • October 22, 2024

How long after should I check the status? Would it take an hour, minutes or seconds to know if the fax failed?

How about for a busy line, say the fax line I am sending to is busy. What would show ?


PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 22, 2024
MysteriousCoder wrote:

How long after should I check the status? Would it take an hour, minutes or seconds to know if the fax failed?

How about for a busy line, say the fax line I am sending to is busy. What would show ?

The system will retry sending several times. You can set a timer to check every 20 secs until you get it Sent or SendingFailed.

But if you don’t want to poll, you can subscribe for the fax event notification and every time you get an event, you can check the status of the fax.

eventFilters: [
    '/restapi/v1.0/account/~/extension/~/message-store?type=Fax&direction=Outbound'
]

// Parse the event and check the fax status
...
var messageIds = []
if (jsonObj.body.changes[0].newCount > 0){
    messageIds = jsonObj.body.changes[0].newMessageIds
    checkFaxStatus(jsonObj.body.changes[0].newMessageIds[0])
}else if (jsonObj.body.changes[0].updatedCount > 0){
    if (messageIds.length > 0){
        checkFaxStatus(messageIds[0])
    }
}


//
async function checkFaxStatus(id){
  try{
    var resp = await platform.get('/restapi/v1.0/account/~/extension/~/message-store/' + id)
    var jsonObj = await resp.json()
    console.log(jsonObj)
  }catch(e){
    console.log(e.message)
  }
}

 


Forum|alt.badge.img
  • Author
  • Participating Frequently
  • 5 replies
  • October 22, 2024

I have one last question, when making these calls, would I be able to see responses from faxes sent through our email via RingCentral?


Forum|alt.badge.img
  • Author
  • Participating Frequently
  • 5 replies
  • October 22, 2024

Would it make more sense to call to the “Call-Log”? 

 

What is the difference between what the call log shows and the message store?


Forum|alt.badge.img
  • Author
  • Participating Frequently
  • 5 replies
  • October 22, 2024

Would it be possible to use Analytics API to see failed fax?


PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 22, 2024
MysteriousCoder wrote:

I have one last question, when making these calls, would I be able to see responses from faxes sent through our email via RingCentral?

I don’t think so. But you can test yourself by sending a fax and check the message store API.


PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 22, 2024
MysteriousCoder wrote:

Would it make more sense to call to the “Call-Log”? 

 

What is the difference between what the call log shows and the message store?

The call log gives you the fax call metadata. The message store gives you the fax message details with attachments, cover page index and text.


PhongVu
Community Manager
Forum|alt.badge.img
  • Community Manager
  • 2282 replies
  • October 22, 2024
MysteriousCoder wrote:

Would it be possible to use Analytics API to see failed fax?

No, currently the Analytics data do not include Fax call data.


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings