Basic Call Logs Services

Display user’s basic call logs

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/basic_call_logs/

Retrieve the logs from the Basic Call Logs service of the user.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/basic_call_logs/ HTTP/1.1
Host: example.com

{}

or

{
   "aggregated": true,
   "ordering": "desc"
}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "placed": [
      {
         "callLogId": "443321:0",
         "phoneNumber": "5002",
         "name": "Unavailable",
         "countryCode": "352",
         "time": "2016-11-24T14:37:31.600000+01:00"
      }
   ],
   "missed": [
      {
         "callLogId": "452977:0",
         "phoneNumber": "5001",
         "name": "Test1 Test1",
         "countryCode": "352",
         "time": "2016-11-29T11:44:34.780000+01:00"
      }
   ],
   "received": [
      {
         "callLogId": "443333:0",
         "phoneNumber": "5002",
         "name": "Test2 Test2",
         "countryCode": "352",
         "time": "2016-11-24T14:38:39.736000+01:00"
      }
   ]
}

or

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "aggregated": [
      {
         "callLogId": "443321:0",
         "phoneNumber": "5002",
         "name": "Unavailable",
         "countryCode": "352",
         "time": "2017-11-24T14:37:31.600000+01:00",
         "type": "missed"
      },
      {
         "callLogId": "452977:0",
         "phoneNumber": "5001",
         "name": "Test1 Test1",
         "countryCode": "352",
         "time": "2016-11-29T11:44:34.780000+01:00",
         "type": "placed"
      },
      {
         "callLogId": "443333:0",
         "phoneNumber": "5002",
         "name": "Test2 Test2",
         "countryCode": "352",
         "time": "2015-11-24T14:38:39.736000+01:00",
         "type": "received"
      }
   ]
}

Request JSON Object:

• aggregated (boolean) – if set it will return a single list as result.

• ordering (string) – it’s the ordering type for the single list. Could be asc (Ascending) or desc (Descending).

Response JSON Object:

• placed (list) – a list of placed calls as defined as Call log attributes.

• missed (list) – a list of missed calls as defined as Call log attributes.

• received (list) – a list of received calls as defined as Call log attributes.

• aggregated (list) – a list of all calls ordered by time, as defined as Call log attributes. This field is only present when the aggregated attribute is True in the request.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

Delete all user’s basic call logs

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/basic_call_logs/

Delete all the call logs of the user.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/basic_call_logs/ HTTP/1.1
Host: example.com

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{}

Call log attributes

Name	Type	Method	Description
		GET
callLogId	String	A	The identifier of the call
phoneNumber	String	A	The phone number or extension of the other party of the call (if available)
name	String	A	The name of the other party of the call. (see First / Last name) (if available)
countryCode	String	A	The country code of the other party of the call
time	String	A	The time of the call
type	String	A	The type of the call. One of “placed”, “missed” or “received”