Retrieve a conversation

GET
/v1/conversations/{id}

Returns one conversation: its channel, the person it is with, who answers it (controller) and, on WhatsApp, whether the 24-hour reply window is open (window). Check window.open before replying on WhatsApp.

Requires an API key with the messages:read scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Path Parameters

id*string

The conversation id.

Response Body

The conversation, with window on a windowed channel

application/json
  1. response
conversation*
Example Request
curl "https://api.vlayers.ai/v1/conversations/$CONVERSATION_ID" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "conversation": {    "id": "0192f5b0-7c3e-7a51-9b2d-4e8f1a6c3d21",    "channel": "sms",    "lineId": "0192f5a8-1a2b-7c3d-8e4f-5a6b7c8d9e01",    "bindingId": null,    "peer": {      "address": "+15550123"    },    "controller": "api",    "status": "open",    "openedAt": "2026-10-20T15:04:05.000Z",    "lastActivityAt": "2026-10-20T15:04:05.000Z",    "test": true  }}