Skip to main content
POST
/
conversations
cURL
curl --request POST \
  --url https://api.pingmee.co.il/conversations \
  --header 'Content-Type: application/json' \
  --header 'Cookie: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phoneNumberId": "<string>",
  "startKey": {},
  "limit": 25
}
'
{
  "dbObject": [
    {
      "platformCompositionKey": "<string>",
      "associatedTo": "<string>",
      "participantsIdentifiers": "<string>",
      "phoneNumberId": "<string>",
      "messageWhatsAppId": "<string>",
      "customerPhoneNumberId": "<string>",
      "customer": {
        "profileImage": "<string>",
        "customerName": "<string>",
        "customerNickname": "<string>",
        "createdAt": 123,
        "lastActiveAt": 123,
        "email": "[email protected]",
        "platform": "whatsapp",
        "phoneNumberId": "<string>",
        "countryCode": "<string>",
        "associatedTo": "<string>",
        "parsedPhoneNumber": "<string>"
      },
      "createdAt": 123,
      "updatedAt": 123,
      "unreadCount": 123,
      "statusCase": "open",
      "answerMode": "bot",
      "lastMessage": {},
      "assignedTagIds": [
        "<string>"
      ],
      "assignedAgentIds": [
        "<string>"
      ],
      "lastWorkflowExecutionId": "<string>",
      "lastWorkflowExecution": {},
      "aiFeatures": {
        "autoTranslation": {}
      },
      "ai": {
        "tokensUsed": 123
      },
      "lastSendMessageFromUser": 123,
      "isOptoutFromMarketingMessages": true
    }
  ],
  "hasMoreItemsToFetch": true,
  "lastEvaluatedKey": {}
}

Authorizations

x-api-key
string
header
required

Body

application/json

Provide pagination and filtering parameters to retrieve the next page of conversations.

phoneNumberId
string

Filter conversations by phone number identifier.

startKey
object

Key returned from a previous request. Pass this value to fetch the next page of conversations.

limit
integer
default:25

Maximum number of conversations to return.

Required range: 1 <= x <= 100

Response

Conversations

dbObject
object[]

List of conversations returned for this page of results.

hasMoreItemsToFetch
boolean
lastEvaluatedKey
object

If present, call the same endpoint again and pass this value as startKey to retrieve the next page of results. Pagination is cursor-based.