Skip to main content
GET
/
conversations
/
{id}
cURL
curl --request GET \
  --url https://api.pingmee.co.il/conversations/{id} \
  --header 'Cookie: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "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
}

Authorizations

​
Cookie
string
header
required
​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Unique identifiers of the conversation participants.

Response

Conversation

​
platformCompositionKey
string
required

Platform and phone/page identifier (e.g. whatsapp#).

​
associatedTo
string
required

Business or account the conversation is associated with.

​
participantsIdentifiers
string
required

Unique identifiers of the conversation participants.

​
phoneNumberId
string
required

Business phone number identifier.

​
messageWhatsAppId
string
required

WhatsApp message identifier.

​
customerPhoneNumberId
string
required

Customer phone number identifier.

​
customer
object
required
​
createdAt
number
required

Unix timestamp (milliseconds) when the conversation was created.

​
updatedAt
number
required

Unix timestamp (milliseconds) when the conversation was last updated.

​
unreadCount
integer
required

Number of unread messages in the conversation.

​
statusCase
enum<string>
required

Conversation status.

Available options:
open,
closed,
standby
​
answerMode
enum<string>
required

Conversation answer mode.

Available options:
bot,
manual,
ai
​
lastMessage
object

Last message exchanged in the conversation.

​
assignedTagIds
string[]

List of assigned conversation tag IDs.

​
assignedAgentIds
string[]

List of assigned agent IDs.

​
lastWorkflowExecutionId
string

Identifier of the last workflow execution.

​
lastWorkflowExecution
object

Last workflow execution data.

​
aiFeatures
object
​
ai
object
​
lastSendMessageFromUser
number

Unix timestamp (milliseconds) of the last message sent by the user.

​
isOptoutFromMarketingMessages
boolean

Indicates whether the customer opted out of marketing messages.