Mediflo
REST APIBot sessions

Get a bot session

Adds the bot’s own structured `outcome` for the call, plus links to the telemetry, transcript and recording sub-resources. Required scope: `bot-calls.read`.

GET/bot-sessions/{dispatchId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

An external API key, sent as Authorization: Bearer mflo_…. Scopes are checked per route; see each operation’s description.

In: header

Path Parameters

dispatchId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/bot-sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "dispatchId": "a1a7028f-f483-4bbb-b8e5-fe878bddb1ae",    "botId": "58ed41f0-04bf-402f-9853-7143ef7dd5ce",    "botName": "string",    "status": "IN_PROGRESS",    "endReason": "string",    "startedAt": "2019-08-24T14:15:22Z",    "endedAt": "2019-08-24T14:15:22Z",    "durationSec": 0,    "phoneNumber": "string",    "attemptId": "string",    "hasTranscript": true,    "hasRecording": true,    "hasTelemetry": true,    "outcome": {      "property1": null,      "property2": null    },    "links": {      "telemetry": "string",      "transcript": "string",      "recording": "string"    }  }}

Get the conversation transcript GET

Separate from `/telemetry` on purpose. `available: false` means the session has no stored transcript. Contains what the caller and the bot said — personal data, including sensitive data. Required scope: `bot-calls.read`.

List bot sessions GET

A bot session is one dispatch of one bot to one number — NOT a telephony call record. `status` filters on the same derived status the response reports. Required scope: `bot-calls.read`.