News & Announcements User Community Developer Community

Welcome to the RingCentral Community

Please note the community is currently under maintenance and is read-only.

Search
Make sure to review our Terms of Use and Community Guidelines.
  Please note the community is currently under maintenance and is read-only.
Home » Developers
How to filter a call log by action and result
Tags: developer sandbox
May 5, 2016 at 8:28am   •   1 replies  •  0 likes
connor-blakely

I am retrieving the call log for a user by sending a GET request via cURl in php. I have had no issue retrieving these logs and adjusting inputs such as perPage or dateFrom.

An example of a successful call(Sandbox):


https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/call-log?view=Simple&dateFrom=20....


However, while viewing the doc found here:

https://developer.ringcentral.com/api-explorer/latest/index.html#/!/Call_Log/loadExtensionCallLog

I do not see how to specify action and result under the GET /v1.0/account/{accountId}/extension/{extensionId}/call-log


I would like to filter the call log by the action of "Phone Call" and result of "Missed".


Is this possible with a GET request or will it have to be done after the records are retrieved?


Thanks,

1 Answer
answered on May 5, 2016 at 9:57am  
There are a few additional query parameters which will get you "closer" to where you want to be (I'll show some URL examples below). The only part that you "should" need to filter the response data for (based on the criteria you've provided) is "result" === "Missed". I've submitted a suggestion to our API Product Management team to consider adding the ability to filter on some of the Call Log Record data in the call-log requests as well. If I learn there is a way to filter by result=Missed, I will update this ticket.

Here are the query parameters you can use to filter call-logs:
  • Filter by Phone Number (cannot be used with extensionNumber query param simultaneously)
    Param Name === phoneNumber
    Value Format === Number, <countryCode><areaCode><exchangeCode><identifier>
    Example === 13215551212

  • Filter by Extension Number (cannot be used with phoneNumber query param simultaneously)
    Param Name === extensionNumber
    Value Format === Number, <extensionNumber> // Note, this is NOT the extension ID
    Example === 104

  • Filter by Voice (Phone Call)
    Param Name === type
    Value Format === String, One of the valid Call Types, either "Voice" -or- "Fax"
    Example === Voice

  • Filter by Direction
    Param Name === direction
    Value Format === String, One of the valid Call Direction strings, either "Inbound" -or- "Outbound"
    Example === Inbound
Here is a cURL example using all of these together (except extensionNumber since we cannot use that and phoneNumber together in same query):

https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/call-log?type=Voice&phoneNumber=13215551212&direction=Inbound

The results of these calls will contain the appropriately time-based range (as defined by the default of last 24 hours, or by using the dateFrom and dateTo query params). Each record will have a "result" property, you will just need to filter out the results by the value "Missed" to get the records you want.

Let me know if you'd like some example code for filtering these results.


 0



A new Community is coming to RingCentral!

Posts are currently read-only as we transition into our new platform.

We thank you for your patience
during this downtime.

Try Workflow Builder

Did you know you can easily automate tasks like responding to SMS, team messages, and more? Plus it's included with RingCentral Video and RingEX plans!

Try RingCentral Workflow Builder

PRODUCTS
RingEX
Message
Video
Phone
OPEN ECOSYSTEM
Developer Platform
APIs
Integrated Apps
App Gallery
Developer support
Games and rewards

RESOURCES
Resource center
Blog
Product Releases
Accessibility
QUICK LINKS
App Download
RingCentral App login
Admin Portal Login
Contact Sales
© 1999-2024 RingCentral, Inc. All rights reserved. Legal Privacy Notice Site Map Contact Us