Filtering Call Logs by Action and Result

Issue:

A user is retrieving call logs via a GET request in PHP using cURL. While filtering by parameters such as perPage and dateFrom is straightforward, they need to filter by action (e.g., "Phone Call") and result (e.g., "Missed").

Solution:

Currently, the API allows filtering call logs using various parameters, but filtering by result directly in the request is not supported. Instead, you must retrieve the full response and filter the results post-request.

Available Query Parameters for Filtering Call Logs:

• Filter by Phone Number (Cannot be used with extensionNumber simultaneously)

  • Parameter: phoneNumber

  • Format: E.164 number (e.g., +13215551212)

• Filter by Extension Number (Cannot be used with phoneNumber simultaneously)

  • Parameter: extensionNumber

  • Format: Numeric extension (e.g., 104)

• Filter by Call Type (Voice or Fax)

  • Parameter: type

  • Format: "Voice" or "Fax"

• Filter by Direction

  • Parameter: direction

  • Format: "Inbound" or "Outbound"

Example cURL Request:

curl -X GET \
  "https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/call-log?type=Voice&phoneNumber=+13215551212&direction=Inbound" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Filtering for Missed Calls:

Since filtering by result="Missed" is not supported in the API request, you must process the response data and filter for records where result === "Missed" after retrieving the data.

Additional Notes:

A suggestion has been submitted to the API Product Management team to add filtering by result. If this feature becomes available, this documentation will be updated accordingly.

If you need example code for filtering the results post-response, let us know!