Official API documentation for Hamkaran Cloud PBX — Website: https://hamkaran.cloud | Cloud PBX Panel: https://cp.hamkaran.cloud

Get Call Center Voicemail Report

GET

https://api.hamkaran.cloud/api/hamkaran/v1/voicemail

This endpoint returns a structured list of voicemail messages that have been left for a given tenant’s extensions. Clients simply supply their integration key in the request header; the API then scans the tenant’s voicemail folders, parses each message’s metadata, and delivers a JSON array containing caller ID, timestamp, voicemail box number, encryption-protected recording URL, and read/unread status. Optional filters for date range, caller name, or specific mailbox allow precise retrieval.
The GetVoicemails API is part of the Hamkaran Cloud ecosystem, providing secure, cloud-based access to voicemail data so teams can monitor customer follow-ups and agent responsiveness without direct server access.
For more details, visit https://hamkaran.cloud.

Request

Query Params

Header Params

Body Params multipart/form-data

Responses

🟢200Response List

text/html

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.hamkaran.cloud/api/hamkaran/v1/voicemail?date=7' \
--header 'key: {{Hamkaran Webservice key}}'

Response Example

Successful Request Response

{
  "data": {
    "2025-08-21-11:29:55": {
      "date": "1404-05-30",                // تاریخ جلالی
      "time": "11:29:55",                  // ساعت
      "voicEmailBox": "990",               // شماره باکس صندوق صوتی
      "callerIdname": "205",               // نام یا شناسه تماس‌گیرنده
      "callerId": 205,                     // شماره تماس‌گیرنده (نرمالایز شده)
      "recordFile": "ENCRYPTED_STRING",    // مسیر فایل ضبط‌شده (رمزنگاری‌شده) جهت ذریافت کلید به api مربوطه ارسال شود
      "target": "default",                 // نوع تارگت (default یا device)
      "isread": "no_read",                 // وضعیت خوانده‌شده: "" یا "no_read"
      "notid": 24122                       // شناسه نوتیفیکیشن مرتبط (اگر وجود داشته باشد)
    },
    "2025-07-31-10:29:31": {
      "date": "1404-05-09",
      "time": "10:29:31",
      "voicEmailBox": "990",
      "callerIdname": "2192009802",
      "callerId": 982192009802,
      "recordFile": "ENCRYPTED_STRING",
      "target": "default",
      "isread": "",
      "notid": null
    }
  }
}

Modified at 2025-09-02 10:31:52

Get Call Center Dashboard Report