Create proactive WhatsApp conversation

Create proactive WhatsApp conversation. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint cria uma conversa proativa com os dados fornecidos.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

This operation has no path, query, or header parameters.

Request body

Content type: application/json · Schema: ProactiveConversationDto

Example request

curl --request POST \
  --url 'https://api.zild.ai/Conversation/whatsapp-proactive-conversation' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "communicationChannel": 0,
  "botId": 0,
  "recipient": [
    "string"
  ],
  "liveAgent": true,
  "conversationTemplateId": 0,
  "counterpartUserId": 0,
  "userId": 0,
  "queueId": 0,
  "contentVariables": {},
  "accountIds": [
    0
  ],
  "contactIds": [
    0
  ],
  "conversationIntegrationType": 0
}'

Responses

Example response (200):

[
  {
    "id": 0,
    "active": true,
    "title": "string",
    "liveAgent": true,
    "from": "string",
    "conversationId": "string",
    "waterMark": "string",
    "token": "string",
    "createdAt": "2026-09-22T18:00:00Z",
    "finishedAt": "2026-09-22T18:00:00Z",
    "queuedAt": "2026-09-22T18:00:00Z",
    "lastConversationUpdateTime": "2026-09-22T18:00:00Z",
    "lastMessageContent": "string",
    "contactId": 0,
    "contactName": "string",
    "userId": 0,
    "userName": "string",
    "counterpartUserId": 0,
    "counterpartUserName": "string",
    "botId": 0,
    "botName": "string",
    "fileUrl": "string",
    "fileName": "string",
    "tenantId": 0,
    "conversationSummary": "string",
    "messages": [
      {
        "id": 0,
        "createdAt": "2026-09-22T18:00:00Z",
        "from": "string",
        "to": "string",
        "content": "string",
        "conversationId": 0,
        "sentiment": "string",
        "offset": "string",
        "isNPS": true,
        "contentSid": "string",
        "messageType": 0,
        "conversationTemplateId": 0,
        "mediaUrl": "string",
        "mediaFileName": "string",
        "tenantId": 0,
        "userId": 0,
        "contentVariables": "string",
        "messageSid": "string",
        "messageStatus": 0,
        "sent": true,
        "delivered": true,
        "read": true,
        "errorCode": "string",
        "errorMessage": "string",
        "isReadByUser": true,
        "documentId": 0
      }
    ],
    "score": 0,
    "finalScore": 0,
    "checklistId": 0,
    "communicationChannel": 0,
    "conversationIntegrationType": 0,
    "duration": "string",
    "highImportanceErrorDetected": true,
    "tags": [
      {
        "id": 0,
        "name": "string",
        "active": true,
        "createdAt": "2026-09-22T18:00:00Z",
        "tenantId": 0
      }
    ],
    "conversationEvaluationStatus": 0,
    "conversationEvaluationStatusMessage": "string",
    "queueId": 0,
    "queueName": "string",
    "conversationEndedReasonId": 0,
    "agentType": 0,
    "conversationType": 0,
    "applicationStatusId": 0,
    "overallSentiment": "string",
    "callStatus": "string",
    "disconnectionReason": "string",
    "callSuccessful": true,
    "totalUnreadedMessagesByUser": 0,
    "dynamicVariables": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "conversationId": 0
      }
    ],
    "dataCollection": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "conversationId": 0
      }
    ],
    "agentId": 0,
    "loadingResponse": true
  }
]

Data models