v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Conversations

post/telephony/message/conversations

Headers

x-api-keystring required

Request body

pagenumber required
limitnumber required

Response

typestring
total_recordsinteger
total_pagesinteger
current_pageinteger

Example response

{
  "type": "success",
  "data": [
    {
      "conversation_uid": "6312e5f7-bc93-4091-b013-ab707930aea2",
      "has_unread": true,
      "unread_count": 6,
      "needs_attention": true,
      "is_unresponded": true,
      "recent_conversation_at": "2025-01-30T06:40:38.000Z",
      "updated_at": "2025-01-30T06:40:41.000Z",
      "created_at": "2025-01-30T06:33:20.000Z",
      "recent_call": {
        "call_uid": "837f1374-9d0e-4012-8f47-3d022c7b5c9c",
        "direction": "INCOMING",
        "status": "COMPLETED",
        "call_recordings": [
          {
            "recording_url": "https://s3.ap-south-1.amazonaws.com/recordings.mp3",
            "recording_duration": 1800,
            "call_summary": {
              "status": "COMPLETED",
              "summary": "The call discusses an API issue where the caller is sending a UID parameter but believes the API is expecting an ID parameter instead. Sushil explains that in the backend, they have configured the object ID as object UID, mapping the UID directly from the database object ID. The issue might be because they haven't used a specific library like UUID4. The caller acknowledges this explanation and says they will check again and get back to Sushil.",
              "sentiment": "NEUTRAL",
              "next_action": [
                "Caller will check the API issue again"
              ],
              "confidence": 98.6084
            }
          }
        ]
      },
      "unread_message": {
        "message_uid": "495c90e3-21a3-4e5a-a536-8269b8438ccf",
        "message_type": "CALL",
        "direction": "INCOMING"
      },
      "customer_number": {
        "customer_number_uid": "e8a16887-c39c-4fb4-bcf9-d4a7bf427be3",
        "customer_uid": "d286467f-0d13-4de8-ab87-3b24faaaa4d1",
        "customer_full_name": "Raghav Gurumani",
        "customer_email": "customer@zuper.co",
        "number": "14632323489",
        "number_type": "HOME",
        "created_at": "2025-01-12T11:56:38.000Z",
        "updated_at": "2025-01-12T11:57:39.000Z"
      },
      "number": {
        "number": "19284652818",
        "display_name": "number",
        "number_uid": "8a943a06-122f-495e-9f9f-e5a60b0340b2"
      },
      "recent_conversation_user": {
        "user_uid": "7c562eb0-f26c-4f07-8cba-11b67c8981dc",
        "first_name": "Sriram",
        "last_name": "Palakula",
        "email": "sriram@zuper.co",
        "profile_picture": "https://engineering.zuperpro.com/profile"
      },
      "assigned_user": {
        "user_uid": "7c562eb0-f26c-4f07-8cba-11b67c8981dc",
        "first_name": "Sriram",
        "last_name": "Palakula",
        "email": "sriram@zuper.co",
        "profile_picture": "https://engineering.zuperpro.com/profile"
      }
    }
  ],
  "total_records": 3,
  "total_pages": 1,
  "current_page": 1
}