question

Hi Scott,

The best way for your use case is to follow the flow below:

1. read all extensions under your account.
2. read call log of each extension one at a time.

var extensionList = []
var endpoint = '/account/~/extension'
var params = {
                    
        status: "Enabled",
        type: "User",
        perPage: 1000
    }
    
platform.get(endpoint, params)
    .then(function(resp){
                    
      var son = resp.json()
      for (var record of json.records){
                    
        var item = {}
         item[extId'] = record.id
         item['extNum'] = record.extensionNumber.toString()
         item['fullName'] = record.contact.firstName + " " + record.contact.lastName

         extensionList.push(item)
        }
      })
      .catch(function(e){
                    
        throw e
      })
// go thru the extensionList and read each extension call log at a time
for (var extension of extensionList){
                    
  var endpoint = '/account/~/extension/'+ extension.extId +'/call-log'
  var params = {
                    
    view: "Detailed",
    dateFrom: dateFrom,
    dateTo: dateTo,
    type: "Voice",
    perPage: 1000
  }
  platform.get(endpoint, params)
    .then(function(resp){
                    
       // parse result from here
   })
   

Then you can process the results from both APIs to get the info you want.

1. Extension => get from your extensionList

2. Agent Name (making the call) => get from your extensionList (remember when you want the name of the caller then check for Outbound call only!)

3. Date and Time of the call made => from the response of call-log (startTime)

4. No. of times the call made to a number => iterate thru the response of each extension to count this value

5. Call status (missed, rejected, received) => from response of call-log (result)

6. Call duration => from response of call-log (duration)

7. Phone number (on which the call is made to) => from response of call-log (to.phoneNumber)

Hope this helps!

+ Phong

Hello Phong,

Thanks for replying.

Yes, we are using "devtest" environment. I see that there are certain "Graduation Requirements" to activate to the "Production" environment, But that won't be a problem to activate the production environment. All we want is to get the following data in the result object:
1. Extension
2. Agent Name (making the call)
3. Date and Time of the call made
4. No. of times the call made to a number
5. Call status (missed, rejected, received)
6. Call duration
7. Phone number (on which the call is made to)

Since I have an admin account on the ring central so I can use "Account Level" API. But when I hit the API URL, I'm not sure if I'm getting the above required data as I couldn't get extension and agent name from the response object.

Is there anything else that needs to be done. Any help will be appreciated. Thanks in advance.

Below is the result that I get by hitting the API URL:

{
  "uri": " https://platform.devtest.ringcentral.com/restapi/v1.0/account/227254004/call-log?view=Detailed&t...;,
  "records": [
    {
      "uri": " https://platform.devtest.ringcentral.com/restapi/v1.0/account/227254004/call-log/AZyj2yIJqFvwzUA?vie...;,
      "id": "AZyj2yIJqFvwzUA",
      "sessionId": "19486376004",
      "startTime": "2018-08-27T13:07:02.897Z",
      "duration": 3,
      "type": "Voice",
      "direction": "Inbound",
      "action": "Phone Call",
      "result": "Missed",
      "to": {
        "phoneNumber": "+19043297097"
      },
      "from": {
        "phoneNumber": "+18007257091"
      },
      "transport": "PSTN",
      "lastModifiedTime": "2018-08-27T13:07:20.001Z",
      "billing": {
        "costIncluded": 0,
        "costPurchased": 0
      },
      "legs": [
        {
          "startTime": "2018-08-27T13:07:02.897Z",
          "duration": 3,
          "type": "Voice",
          "direction": "Inbound",
          "action": "Phone Call",
          "result": "Missed",
          "to": {
            "phoneNumber": "+19043297097"
          },
          "from": {
            "phoneNumber": "+18007257091"
          },
          "transport": "PSTN",
          "billing": {
            "costIncluded": 0,
            "costPurchased": 0
          },
          "legType": "Accept",
          "master": true
        }
      ]
    },
    {
      "uri": " https://platform.devtest.ringcentral.com/restapi/v1.0/account/227254004/call-log/AZvPIrGP5pMgzUA?vie...;,
      "id": "AZvPIrGP5pMgzUA",
      "sessionId": "19447136004",
      "startTime": "2018-08-20T12:59:40.202Z",
      "duration": 3,
      "type": "Voice",
      "direction": "Inbound",
      "action": "Phone Call",
      "result": "Missed",
      "to": {
        "phoneNumber": "+19043297097"
      },
      "from": {
        "phoneNumber": "+18007257091"
      },
      "transport": "PSTN",
      "lastModifiedTime": "2018-08-20T13:00:00.004Z",
      "billing": {
        "costIncluded": 0,
        "costPurchased": 0
      },
      "legs": [
        {
          "startTime": "2018-08-20T12:59:40.202Z",
          "duration": 3,
          "type": "Voice",
          "direction": "Inbound",
          "action": "Phone Call",
          "result": "Missed",
          "to": {
            "phoneNumber": "+19043297097"
          },
          "from": {
            "phoneNumber": "+18007257091"
          },
          "transport": "PSTN",
          "billing": {
            "costIncluded": 0,
            "costPurchased": 0
          },
          "legType": "Accept",
          "master": true
        }
      ]
    }
  ],
  "paging": {
    "page": 1,
    "perPage": 100,
    "pageStart": 0,
    "pageEnd": 24
  },
  "navigation": {
    "firstPage": {
      "uri": " https://platform.devtest.ringcentral.com/restapi/v1.0/account/227254004/call-log?view=Detailed&t...;
    },
    "lastPage": {
      "uri": " https://platform.devtest.ringcentral.com/restapi/v1.0/account/227254004/call-log?view=Detailed&t...;
    }
  }
}

Hello Phong,

Thanks for the reply. Yes, I see what I need to do. But another problem that I am facing now is that my company has over 60 employees using RingCentral to make calls. So, when I try to hit the API as per every agent's extensionNumber, I receive an error of "Request Rate Exceeded". Is there any wat to increase the request rates per minute? I'm using "RingCentral Office Premium 2" plan.

Thanks in advance.

Hi Scott,

Yes, that was the API rate limit. I can increase the limit for your company but it may not help in the case of reading a lot of data. The best way is to cause a few second delay between reading each extension or API call.

Let me know,
+ Phong

Oh Great! I tried looping with some sleep time of few seconds and it worked.

The extensionNumber (101, 102, max 5 digits) is not the same as the extension Id (internal ID)!

As I said earlier, you need to use the Extension List API to get a list of all extension IDs of your account, then use the extension Id instead of the tilde (~) to read call log of that extension.

Now, don't use the extensionNumber query parameter to read call log for that extension even if you login with the Admin (from both service dashboard and API).

+ Phong

Phong,

Thank you so much. It solved my problem.

Hi Scott,

I think the description of the extensionNumber query param is incorrect. It is kind a filter to search for call log items that contain the extension number. Not reading the call log for that extension.

So to read the call log at extension level can be done only by either following ways:

1. Login with the extension's credentials then read it  https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~call-log?

2. Login with an admin user then get the extension Id of the extension you want to read, then read it:  https://platform.ringcentral.com/restapi/v1.0/account/~/extension/xxxxxxxxx/call-log?

Hope this helps,
+ Phong

Phong,

Thanks for your response.

I'm trying the 'Extension Level' API #2 that you have mentioned above. Below are the steps that I followed:

1. I logged into my admin portal of RingCentral.
2. I went to 'Call Log' menu. Added the filters:

• Date Range => From 09/20/2018 To 09/21/2018
• Advanced Features => Type of call: Voice, VoIP; Direction: Inbound, Outbound; Extension: 33345

And then clicked on 'Show' button.
3. It displayed me the below records:


4. Now, to test the results of my API, I'm using following PHP code:

$rcsdk = new SDK($this->client_id, $this->client_secret, SDK::SERVER_PRODUCTION);
$platform = $rcsdk->platform();
$platform->login('MY_USERID', MY_EXTENSION, 'MY_PASSWORD');

if ($platform->loggedIn()) {
      $call_log_records = $platform->get('/account/~/extension/33345/call-log', [
            'type' => 'Voice',
            'view' => 'Simple',
            'dateFrom' => '2018-09-20',
            'dateTo' => '2018-09-21'
       ])->json()->records;
      if (!empty($call_log_records)) {
            $call_details[33345] = $call_log_records;
       }
}

pr($call_details);
die('test');
================================================================
Response:

Resource for parameter [extensionId] is not found

================================================================

To find out the reason of above output, I went on seraching what exactly "extensionId" means. I got the information that "extensionId: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session". And, "extensionNumber: Extension number of a user. If specified, returns call log for a particular extension only".

5. Now, I tried this approach:

$rcsdk = new SDK($this->client_id, $this->client_secret, SDK::SERVER_PRODUCTION);
$platform = $rcsdk->platform();
$platform->login('MY_USERID', MY_EXTENSION, 'MY_PASSWORD');

if ($platform->loggedIn()) {
      $call_log_records = $platform->get('/account/~/extension/~/call-log', [
            'extensionNumber' => 33345,
            'type' => 'Voice',
            'view' => 'Simple',
            'dateFrom' => '2018-09-20',
            'dateTo' => '2018-09-21'
       ])->json()->records;
}

pr($call_log_records);
die();

================================================================
Response:

Array ( )

================================================================

Both ways failed for me.

Thanks in advance!