Conversations

Endpointhttps://api.neuratel.ai

List Conversations

GET

https://api.neuratel.ai

/v1/conversations

List Conversations › query Parameters

channel

Filter by channel: sms or whatsapp_chat. Omit for all.

status

Filter by status: active/ended/timed_out/closed

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 200

Default: 50

List Conversations › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

GET/v1/conversations

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations

shell

Example Responses

{
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "agent_id": "00000000-0000-0000-0000-000000000000",
      "channel": "channel",
      "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
      "phone_number_id": "00000000-0000-0000-0000-000000000000",
      "contact_address": "contact_address",
      "business_address": "business_address",
      "contact_name": "string",
      "dynamic_variables": {},
      "status": "status",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "end_reason": "string",
      "message_count": 0,
      "last_message_at": "2024-08-25T15:00:00Z",
      "last_message": {
        "id": "string",
        "external_message_id": "string",
        "type": "type",
        "body": "string",
        "direction": "direction",
        "status": "status",
        "sent_at": "2024-08-25T15:00:00Z"
      },
      "last_read_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "count": 100,
    "has_more": true,
    "limit": 100,
    "skip": 0,
    "total": 250
  }
}

json

application/json

Get Conversation

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}

Get Conversation › path Parameters

conversation_id

string · uuid · required

Get Conversation › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

GET/v1/conversations/{conversation_id}

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update Conversation Dynamic Variables

PATCH

https://api.neuratel.ai

/v1/conversations/{conversation_id}/dynamic_variables

Set or merge per-conversation runtime variables.

Replaces the dual-purpose dynamic_variables field that used to live on every send request — Stage 7c (option A) split context-setting out of message-send so the freeform composer doesn't carry vars dead weight. Operators call this once at first contact (typically right before the first send) to seed the agent's reply context. The agent's _run_direct_chat reads from conversation.dynamic_variables on every reply turn.

Default merge semantics (replace=False): caller-supplied keys are merged into the existing bucket. Pass replace=True to fully overwrite. system__* keys are stripped — platform-controlled.

Update Conversation Dynamic Variables › path Parameters

conversation_id

string · uuid · required

Update Conversation Dynamic Variables › Request Body

Operator update to a conversation's per-conversation runtime variable bucket. Replaces the dual-purpose ``dynamic_variables`` field that used to live on every send request — Stage 7c (option A) split context-setting out of message-send so the freeform composer doesn't carry vars dead-weight. Default merge semantics: caller-supplied keys are merged into the existing bucket (last-write-wins per key). Pass ``replace=True`` to fully overwrite — useful for "operator typed a fresh attribute set" flows where stale keys should be cleared.

object

Map of variable name to value. Keys with reserved prefix system__ are stripped server-side (platform-controlled).

replace

boolean

True = full replace (existing keys not in the payload are cleared). False (default) = merge into existing bucket.

Default: false

Update Conversation Dynamic Variables › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

PATCH/v1/conversations/{conversation_id}/dynamic_variables

curl --request PATCH \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/dynamic_variables \
  --header 'Content-Type: application/json' \
  --data '
{
  "dynamic_variables": {
    "key": "string"
  },
  "replace": false
}
'

shell

Example Request Body

{
  "dynamic_variables": {
    "key": "string"
  },
  "replace": false
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List Messages

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}/messages

List Messages › path Parameters

conversation_id

string · uuid · required

List Messages › query Parameters

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 200

Default: 50

since

Return only messages with sent_at strictly greater than this ISO timestamp (used by SSE reconnect backfill).

before

Return only messages with sent_at strictly less than this ISO timestamp (used by reverse infinite scroll).

List Messages › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

GET/v1/conversations/{conversation_id}/messages

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/messages

shell

Example Responses

{
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "conversation_id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "channel": "channel",
      "direction": "direction",
      "external_message_id": "external_message_id",
      "client_temp_id": "string",
      "message_type": "message_type",
      "body": "string",
      "media_id": "string",
      "media_url": "string",
      "media_mime_type": "string",
      "template_name": "string",
      "template_params": [
        {}
      ],
      "interactive_type": "string",
      "interactive_payload": {},
      "status": "status",
      "error_message": "string",
      "sent_at": "2024-08-25T15:00:00Z",
      "delivered_at": "2024-08-25T15:00:00Z",
      "read_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "count": 100,
    "has_more": true,
    "limit": 100,
    "skip": 0,
    "total": 250
  }
}

json

application/json

Send Message

POST

https://api.neuratel.ai

/v1/conversations/{conversation_id}/messages

Send an outbound message inside an existing conversation.

The provider is picked from conversation.channel:

sms → SMS carrier
whatsapp_chat → Meta WhatsApp Cloud API (text only on this route)

Channel-specific surfaces (WhatsApp templates, voice notes, media MMS workflows) stay under /v1/whatsapp/... and /v1/messaging/....

Send Message › path Parameters

conversation_id

string · uuid · required

Send Message › Request Body

Send a message inside an existing conversation.

body

string · minLength: 1 · maxLength: 4096 · required

MMS attachments (SMS only — WhatsApp text endpoint rejects).

Client-supplied id echoed back for optimistic UI reconciliation.

Send Message › Responses

Successful Response

id

string · uuid · required

conversation_id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

direction

string · required

external_message_id

string · required

message_type

string · required

status

string · required

sent_at

string · date-time · required

POST/v1/conversations/{conversation_id}/messages

curl --request POST \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "body",
  "media_urls": [
    "string"
  ],
  "client_temp_id": "string"
}
'

shell

Example Request Body

{
  "body": "body",
  "media_urls": [
    "string"
  ],
  "client_temp_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "conversation_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "direction": "direction",
  "external_message_id": "external_message_id",
  "client_temp_id": "string",
  "message_type": "message_type",
  "body": "string",
  "media_id": "string",
  "media_url": "string",
  "media_mime_type": "string",
  "template_name": "string",
  "template_params": [
    {}
  ],
  "interactive_type": "string",
  "interactive_payload": {},
  "status": "status",
  "error_message": "string",
  "sent_at": "2024-08-25T15:00:00Z",
  "delivered_at": "2024-08-25T15:00:00Z",
  "read_at": "2024-08-25T15:00:00Z"
}

json

application/json

Mark Conversation Read

POST

https://api.neuratel.ai

/v1/conversations/{conversation_id}/read

Mark Conversation Read › path Parameters

conversation_id

string · uuid · required

Mark Conversation Read › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

POST/v1/conversations/{conversation_id}/read

curl --request POST \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/read

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List Conversation Timeline

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}/timeline

Unified message + voice-call stream for a conversation.

Returns {kind: "message", id, sent_at, message: MessageResponse} or {kind: "call", id, sent_at, call: VoiceSessionResponse} per item. The frontend picks the right renderer based on kind.

List Conversation Timeline › path Parameters

conversation_id

string · uuid · required

List Conversation Timeline › query Parameters

limit

integer · min: 1 · max: 200

Default: 50

since

before

List Conversation Timeline › Responses

Successful Response

No data returned

Chat Analytics Dashboard

GET

https://api.neuratel.ai

/v1/conversations/analytics/dashboard

Chat Analytics Dashboard › query Parameters

start_date

Inclusive ISO start. Default: 7 days ago.

end_date

Inclusive ISO end. Default: now.

channel

Filter by channel: sms or whatsapp_chat

agent_id

interval

string · pattern: ^(hour|day|week)$

Volume bucket size

Default: day

Chat Analytics Dashboard › Responses

Successful Response

Chat-side analytics payload mirroring the voice dashboard contract.

start_date

string · required

end_date

string · required

object · required

Top-line chat dashboard KPIs.

object[]

GET/v1/conversations/analytics/dashboard

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/analytics/dashboard

shell

Example Responses

{
  "start_date": "start_date",
  "end_date": "end_date",
  "kpis": {
    "active_conversations": 0,
    "total_messages": 0,
    "inbound_messages": 0,
    "outbound_messages": 0,
    "avg_messages_per_conversation": 0,
    "avg_first_response_seconds": 0
  },
  "by_channel": [
    {
      "channel": "channel",
      "conversations": 0,
      "messages_total": 0,
      "messages_inbound": 0,
      "messages_outbound": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0
    }
  ],
  "volume_series": [
    {
      "date": "date",
      "sms": 0,
      "whatsapp_chat": 0,
      "total": 0
    }
  ],
  "delivery_breakdown": [
    {
      "channel": "channel",
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0
    }
  ]
}

json

application/json

Voice DNC

Neuratel API

Conversations

Endpointhttps://api.neuratel.ai

List Conversations

GET

https://api.neuratel.ai

/v1/conversations

List Conversations › query Parameters

channel

Filter by channel: sms or whatsapp_chat. Omit for all.

status

Filter by status: active/ended/timed_out/closed

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 200

Default: 50

List Conversations › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

GET/v1/conversations

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations

shell

Example Responses

{
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "agent_id": "00000000-0000-0000-0000-000000000000",
      "channel": "channel",
      "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
      "phone_number_id": "00000000-0000-0000-0000-000000000000",
      "contact_address": "contact_address",
      "business_address": "business_address",
      "contact_name": "string",
      "dynamic_variables": {},
      "status": "status",
      "started_at": "2024-08-25T15:00:00Z",
      "ended_at": "2024-08-25T15:00:00Z",
      "end_reason": "string",
      "message_count": 0,
      "last_message_at": "2024-08-25T15:00:00Z",
      "last_message": {
        "id": "string",
        "external_message_id": "string",
        "type": "type",
        "body": "string",
        "direction": "direction",
        "status": "status",
        "sent_at": "2024-08-25T15:00:00Z"
      },
      "last_read_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "count": 100,
    "has_more": true,
    "limit": 100,
    "skip": 0,
    "total": 250
  }
}

json

application/json

Get Conversation

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}

Get Conversation › path Parameters

conversation_id

string · uuid · required

Get Conversation › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

GET/v1/conversations/{conversation_id}

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update Conversation Dynamic Variables

PATCH

https://api.neuratel.ai

/v1/conversations/{conversation_id}/dynamic_variables

Set or merge per-conversation runtime variables.

Default merge semantics (replace=False): caller-supplied keys are merged into the existing bucket. Pass replace=True to fully overwrite. system__* keys are stripped — platform-controlled.

Update Conversation Dynamic Variables › path Parameters

conversation_id

string · uuid · required

Update Conversation Dynamic Variables › Request Body

object

Map of variable name to value. Keys with reserved prefix system__ are stripped server-side (platform-controlled).

replace

boolean

True = full replace (existing keys not in the payload are cleared). False (default) = merge into existing bucket.

Default: false

Update Conversation Dynamic Variables › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

PATCH/v1/conversations/{conversation_id}/dynamic_variables

curl --request PATCH \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/dynamic_variables \
  --header 'Content-Type: application/json' \
  --data '
{
  "dynamic_variables": {
    "key": "string"
  },
  "replace": false
}
'

shell

Example Request Body

{
  "dynamic_variables": {
    "key": "string"
  },
  "replace": false
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List Messages

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}/messages

List Messages › path Parameters

conversation_id

string · uuid · required

List Messages › query Parameters

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 200

Default: 50

since

Return only messages with sent_at strictly greater than this ISO timestamp (used by SSE reconnect backfill).

before

Return only messages with sent_at strictly less than this ISO timestamp (used by reverse infinite scroll).

List Messages › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

GET/v1/conversations/{conversation_id}/messages

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/messages

shell

Example Responses

{
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "conversation_id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "channel": "channel",
      "direction": "direction",
      "external_message_id": "external_message_id",
      "client_temp_id": "string",
      "message_type": "message_type",
      "body": "string",
      "media_id": "string",
      "media_url": "string",
      "media_mime_type": "string",
      "template_name": "string",
      "template_params": [
        {}
      ],
      "interactive_type": "string",
      "interactive_payload": {},
      "status": "status",
      "error_message": "string",
      "sent_at": "2024-08-25T15:00:00Z",
      "delivered_at": "2024-08-25T15:00:00Z",
      "read_at": "2024-08-25T15:00:00Z"
    }
  ],
  "metadata": {
    "count": 100,
    "has_more": true,
    "limit": 100,
    "skip": 0,
    "total": 250
  }
}

json

application/json

Send Message

POST

https://api.neuratel.ai

/v1/conversations/{conversation_id}/messages

Send an outbound message inside an existing conversation.

The provider is picked from conversation.channel:

sms → SMS carrier
whatsapp_chat → Meta WhatsApp Cloud API (text only on this route)

Channel-specific surfaces (WhatsApp templates, voice notes, media MMS workflows) stay under /v1/whatsapp/... and /v1/messaging/....

Send Message › path Parameters

conversation_id

string · uuid · required

Send Message › Request Body

Send a message inside an existing conversation.

body

string · minLength: 1 · maxLength: 4096 · required

MMS attachments (SMS only — WhatsApp text endpoint rejects).

Client-supplied id echoed back for optimistic UI reconciliation.

Send Message › Responses

Successful Response

id

string · uuid · required

conversation_id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

direction

string · required

external_message_id

string · required

message_type

string · required

status

string · required

sent_at

string · date-time · required

POST/v1/conversations/{conversation_id}/messages

curl --request POST \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "body",
  "media_urls": [
    "string"
  ],
  "client_temp_id": "string"
}
'

shell

Example Request Body

{
  "body": "body",
  "media_urls": [
    "string"
  ],
  "client_temp_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "conversation_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "direction": "direction",
  "external_message_id": "external_message_id",
  "client_temp_id": "string",
  "message_type": "message_type",
  "body": "string",
  "media_id": "string",
  "media_url": "string",
  "media_mime_type": "string",
  "template_name": "string",
  "template_params": [
    {}
  ],
  "interactive_type": "string",
  "interactive_payload": {},
  "status": "status",
  "error_message": "string",
  "sent_at": "2024-08-25T15:00:00Z",
  "delivered_at": "2024-08-25T15:00:00Z",
  "read_at": "2024-08-25T15:00:00Z"
}

json

application/json

Mark Conversation Read

POST

https://api.neuratel.ai

/v1/conversations/{conversation_id}/read

Mark Conversation Read › path Parameters

conversation_id

string · uuid · required

Mark Conversation Read › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

channel

string · required

contact_address

string · required

business_address

string · required

status

string · required

started_at

string · date-time · required

message_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object

POST/v1/conversations/{conversation_id}/read

curl --request POST \
  --url https://api.neuratel.ai/v1/conversations/:conversation_id/read

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "whatsapp_account_id": "00000000-0000-0000-0000-000000000000",
  "phone_number_id": "00000000-0000-0000-0000-000000000000",
  "contact_address": "contact_address",
  "business_address": "business_address",
  "contact_name": "string",
  "dynamic_variables": {},
  "status": "status",
  "started_at": "2024-08-25T15:00:00Z",
  "ended_at": "2024-08-25T15:00:00Z",
  "end_reason": "string",
  "message_count": 0,
  "last_message_at": "2024-08-25T15:00:00Z",
  "last_message": {
    "id": "string",
    "external_message_id": "string",
    "type": "type",
    "body": "string",
    "direction": "direction",
    "status": "status",
    "sent_at": "2024-08-25T15:00:00Z"
  },
  "last_read_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List Conversation Timeline

GET

https://api.neuratel.ai

/v1/conversations/{conversation_id}/timeline

Unified message + voice-call stream for a conversation.

Returns {kind: "message", id, sent_at, message: MessageResponse} or {kind: "call", id, sent_at, call: VoiceSessionResponse} per item. The frontend picks the right renderer based on kind.

List Conversation Timeline › path Parameters

conversation_id

string · uuid · required

List Conversation Timeline › query Parameters

limit

integer · min: 1 · max: 200

Default: 50

since

before

List Conversation Timeline › Responses

Successful Response

No data returned

Chat Analytics Dashboard

GET

https://api.neuratel.ai

/v1/conversations/analytics/dashboard

Chat Analytics Dashboard › query Parameters

start_date

Inclusive ISO start. Default: 7 days ago.

end_date

Inclusive ISO end. Default: now.

channel

Filter by channel: sms or whatsapp_chat

agent_id

interval

string · pattern: ^(hour|day|week)$

Volume bucket size

Default: day

Chat Analytics Dashboard › Responses

Successful Response

Chat-side analytics payload mirroring the voice dashboard contract.

start_date

string · required

end_date

string · required

object · required

Top-line chat dashboard KPIs.

object[]

GET/v1/conversations/analytics/dashboard

curl --request GET \
  --url https://api.neuratel.ai/v1/conversations/analytics/dashboard

shell

Example Responses

{
  "start_date": "start_date",
  "end_date": "end_date",
  "kpis": {
    "active_conversations": 0,
    "total_messages": 0,
    "inbound_messages": 0,
    "outbound_messages": 0,
    "avg_messages_per_conversation": 0,
    "avg_first_response_seconds": 0
  },
  "by_channel": [
    {
      "channel": "channel",
      "conversations": 0,
      "messages_total": 0,
      "messages_inbound": 0,
      "messages_outbound": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0
    }
  ],
  "volume_series": [
    {
      "date": "date",
      "sms": 0,
      "whatsapp_chat": 0,
      "total": 0
    }
  ],
  "delivery_breakdown": [
    {
      "channel": "channel",
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0
    }
  ]
}

json

application/json

Voice DNC