Hot to get api call schema for Specific Reports

Your developer guide outlines how to make an api call to the ring cx platform to retrieve a report called DIALER_RESULT_DOWNLOAD. https://developers.ringcentral.com/engage/voice/guide/analytics/reports/dialer-result-download-report

However there are very specific schema in the call that apply only to that report. These are referenced as report criteria in the body of the request. For example the GLOBAL_CALL_TYPE report has a different set of schema https://developers.ringcentral.com/engage/voice/guide/analytics/reports/global-call-type-detail-report

 "reportCriteria":{
        "criteriaType":"DIALER_RESULT_DOWNLOAD_CRITERIA",
        "startDate":"2020-04-22T00:00:00.000-0000",
    "includeAuxData":true,
    "includeXferData":true,
    "includeSpeedToLead":true,
    "dialedLeadsReportType":"ALL_LEADS",
    "systemDisposition:":"ALL",
    "schedule": {
      "repeatOption":"ONCE",
      "scheduleTimezoneName":"US/Eastern"
    }

vs.

   "reportCriteria":{
        "criteriaType":"GLOBAL_CALL_TYPE_CRITERIA",
        "startDate":"2020-04-22T00:00:00.000-0000",
        "containGates":true,
        "containCampaigns":true,
        "containIvrStudios":true,
        "containCloudProfiles":true,
        "containTracNumbers":true,
        "containAgents":true,
        "includeNoAnswers":false
    }

How do we get this report criteria if i want to pull a different report than the two examples?
I have tried omitting everything except the start date which is listed as required in the documentation but that is not successful.

Page 1 / 1

@banditoBurrito the APIs above are deprecated and we recommend that users configure scheduled reports instead. These old report APIs don’t match the current reports we have in RingCX.

If you need API reports, have you researched the Integration Reports?
https://developers.ringcentral.com/engage/voice/guide/integration#integration-reports

FYI, those are changing soon too.

@Craig C.

Hey Craig,
Thanks for your response.

I also have an open ticket for email scheduled reports as i am getting a csv file with the endpoint of a URI instead of the actual report for the DIALER_RESULT_DOWNLOAD report above. This was scheduled with the analytics front end interface you have available, not the api.

That being said, i also have no ability to set parameters on scheduled reports.

For example we need to be able to see all agent disposition for all calls, and we also need to see the date that disposition was set and the agent that set it. If i pull a report of all calls the reports is tens of thousands of lines long because it includes unanswered call and i can not set any filter parameters for the scheduled download. I hypothesize this is why the email scheduler is failing. This will only increase as we make more calls. Is there really no API for downloading a report available to us on the front end?

Bump.

I still have no automated way to pull the reports we need.
That’s a bare bones basic API functionality.

Did you try this?
https://developers.ringcentral.com/engage/voice/api-reference/Queue-Dispositions/getGateDispositionList

@Craig C. Your provided endpoint returns a static list of the dispositions available. Basically just the options available to select from. It’s also only for inbound queues.

What we need is the agent disposition that was selected by the agent during or after the call for all transactions. This could be an outbound, inbound, or a manual pass. The report i mentioned in the first post contains all of this information when it is downloaded from the front end interface. I would like to automate it or retrieve it from the api.

As a workaround I attempted to setup web-hooks for outbound and inbound calls. However i believe the manual pass is still not addressed with this workaround..

Reply

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded