Call Log Pull API

Kaleyra.io lets you access the call log of your Kaleyra account via the UI (Channel>Voice>Logs screen). Logs screen displays information like the type of call, from and to numbers, call start time, bridge number, call status, duration of the call, and the credits utilized for the call.

The same can be achieved using the Call Log Pull API. Kaleyra.io offers the Call Log Pull API to access the call log details of your Kaleyra account for a period of 7 days using parameters like start time, end time, status, and so on.

Base URL

<https://api.kaleyra.io/v1/><SID>

1. Signup or Login to Kaleyra.io and create your API key

Refer to the Create an API Key page for steps to create your API key. To view the API Key and the SID, see View API Key and SID.

📘

Note:

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in Kaleyra.io.After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in Kaleyra.io.

2. API request to access the call log details

Request Format

To get the call log, use the following voice/call-logs endpoint.

curl -X GET '<URL>/v1/<SID>/voice/call-logs' \
-H 'Content-Type: <CONTENT_TYPE>' \
-H "api-key: <API_KEY>" \
-H 'limit: <LIMIT>' \
-d 'status=<STATUS>' \
-d 'call_id=<CALL_ID>' \
-d 'start_time=<START_TIME>' \
-d 'end_time=<END_TIME>' \
-d 'page=<PAGE>' \
-d 'offset=<OFFSET>' \
-d 'bridge=<BRIDGE>'

Provide the details listed in the Parameters and Variable section.

Parameters and Data Types

Following is the list of parameters and data types supported:

Sample Success Response

Call Log Pull success response

{
    "status": 200,
    "code": "RBC103",
    "message": "Request successfully executed!",
    "data": [],
    "error": {},
    "total": 0,
    "offset": 0,
    "limit": 25,
    "page": 1
}

Sample Failure Response

Call Log Pull failure response with an invalid SID or API key
If your response fails due to the invalid SID or API key, re-execute the command with a valid SID or API key.

{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}

Call Log Pull failure response when incorrect start time is provided
If your response fails due to the invalid values, re-execute the command with valid values.

{
    "code": "RBC3004",
    "message": "Incorrect start time.",
    "data": [],
    "error": {
        "error": "Incorrect start time."
    }
}

HTTP Status Code and Response Code

For more information regarding the HTTP Status Codes and Response Codes, refer to Voice Error Codes.