Skip to main content
POST
/
conversations
/
{conversationId}
/
messages
Add a message from the agent to a conversation.
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "reference_id": 123,
  "text": {
    "content": "<string>"
  },
  "image": {
    "caption": "<string>"
  },
  "video": {
    "caption": "<string>"
  },
  "audio": {
    "voice": true
  },
  "document": {
    "filename": "<string>",
    "caption": "<string>"
  },
  "location": {
    "latitude": "<string>",
    "longitude": "<string>",
    "remaining_fields": "See location schema."
  },
  "contact": {
    "name": {
      "formatted_name": "<string>"
    },
    "remaining_fields": "See contact schema."
  },
  "file": {
    "url": "<string>",
    "mime_type": "<string>",
    "size": 123,
    "internal_uuid": "<string>"
  }
}'
{
  "data": {
    "id": 123,
    "conversation_id": 123,
    "from": "system",
    "source": "user",
    "user_id": 123,
    "contents": [
      {
        "type": "text",
        "content": "<string>"
      }
    ],
    "status": "created",
    "agent_reaction": "<string>",
    "customer_reaction": "<string>",
    "sent_at": "2023-01-01T12:00:00Z",
    "reference": {},
    "latest_error": {
      "id": 123,
      "message_id": 123,
      "type": "status-update",
      "original_message": "<string>",
      "created_at": "2023-01-01T12:00:00Z"
    },
    "whatsapp_campaign": {
      "id": 123,
      "name": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

conversationId
integer
required

Body

application/json
type
string
reference_id
integer | null

ID of message within the same conversation this message is referring to.

text
object
image
object
video
object
audio
object
document
object
location
object
contact
object
file
object

Used when type is image / video / audio / document.

Response

200 - application/json

Success

data
object

A message within a conversation.