Returns conversations

GET

/api/partners/whatsapp-conversations

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200

application/json

Body

🟠400

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location --request GET 'api.velosms.com/api/partners/whatsapp-conversations?PageNumber=&PageSize=' \
--header 'apiId: <string>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Conversations

{
  "data": [
    {
      "items": [
        {
          "id": "<long>",
          "chatId": "<string>",
          "fromPhoneNumber": "<string>",
          "toPhoneNumber": "<string>",
          "userName": "<string>",
          "message": "<string>",
          "receivedAt": "<dateTime>",
          "campaignId": "<long>",
          "unreadMessagesCount": "<integer>",
          "whatsAppMedias": [
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "lastMessage": {
            "value": "<Circular reference to #/components/schemas/WhatsAppConversationGetModel detected>"
          }
        },
        {
          "id": "<long>",
          "chatId": "<string>",
          "fromPhoneNumber": "<string>",
          "toPhoneNumber": "<string>",
          "userName": "<string>",
          "message": "<string>",
          "receivedAt": "<dateTime>",
          "campaignId": "<long>",
          "unreadMessagesCount": "<integer>",
          "whatsAppMedias": [
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "lastMessage": {
            "value": "<Circular reference to #/components/schemas/WhatsAppConversationGetModel detected>"
          }
        }
      ],
      "totalCount": "<long>",
      "pageSize": "<integer>",
      "pageNumber": "<integer>"
    },
    {
      "items": [
        {
          "id": "<long>",
          "chatId": "<string>",
          "fromPhoneNumber": "<string>",
          "toPhoneNumber": "<string>",
          "userName": "<string>",
          "message": "<string>",
          "receivedAt": "<dateTime>",
          "campaignId": "<long>",
          "unreadMessagesCount": "<integer>",
          "whatsAppMedias": [
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "lastMessage": {
            "value": "<Circular reference to #/components/schemas/WhatsAppConversationGetModel detected>"
          }
        },
        {
          "id": "<long>",
          "chatId": "<string>",
          "fromPhoneNumber": "<string>",
          "toPhoneNumber": "<string>",
          "userName": "<string>",
          "message": "<string>",
          "receivedAt": "<dateTime>",
          "campaignId": "<long>",
          "unreadMessagesCount": "<integer>",
          "whatsAppMedias": [
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            },
            {
              "id": "<long>",
              "key": "<string>",
              "url": "<string>"
            }
          ],
          "lastMessage": {
            "value": "<Circular reference to #/components/schemas/WhatsAppConversationGetModel detected>"
          }
        }
      ],
      "totalCount": "<long>",
      "pageSize": "<integer>",
      "pageNumber": "<integer>"
    }
  ]
}

Modified at 2025-12-05 09:59:33

Returns conversation messages

Returns sender ids