List Calls

List Calls

curl --request GET \
  --url https://api.decodahealth.com/comms/call/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "receiver": {
        "id": "<string>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "chatId": "<string>",
      "direction": "INBOUND",
      "status": "CREATED",
      "sender": {
        "id": "<string>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "completedDate": "2023-11-07T05:31:56Z",
      "retellCallId": "<string>",
      "disconnectionReason": "<string>",
      "pathToAudio": "<string>",
      "summary": "<string>",
      "context": {},
      "createdDate": "2023-11-07T05:31:56Z",
      "toolCalls": [],
      "tags": [],
      "invoiceId": "<string>",
      "type": "MANUAL",
      "locationId": "<string>"
    }
  ],
  "total": 123
}

GET

comms

call

list

List Calls

curl --request GET \
  --url https://api.decodahealth.com/comms/call/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "receiver": {
        "id": "<string>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "chatId": "<string>",
      "direction": "INBOUND",
      "status": "CREATED",
      "sender": {
        "id": "<string>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "completedDate": "2023-11-07T05:31:56Z",
      "retellCallId": "<string>",
      "disconnectionReason": "<string>",
      "pathToAudio": "<string>",
      "summary": "<string>",
      "context": {},
      "createdDate": "2023-11-07T05:31:56Z",
      "toolCalls": [],
      "tags": [],
      "invoiceId": "<string>",
      "type": "MANUAL",
      "locationId": "<string>"
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

patient_id

string | null

user_id

string | null

user_name

string | null

created_date

string<date-time>[] | null

duration

integer | null

direction

enum<string> | null

Available options:

INBOUND,

OUTBOUND

status

enum<string>[] | null

Available options:

CREATED,

ONGOING,

TRANSFERRED,

DISCONNECTED,

FAILED,

FINISHED,

VOICEMAIL

transcript_contains

string | null

Response

Successful Response

data

CallTable · object[]

required

Show child attributes

data.id

string

required

data.receiver

UserTiny · object

required

Show child attributes

data.receiver.id

string

required

The unique identifier for the user.

data.receiver.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.receiver.firstName

string | null

The user's first name.

data.receiver.lastName

string | null

The user's last name.

data.receiver.phoneNumber

string | null

The user's phone number.

data.receiver.email

string | null

The user's email address.

data.receiver.locationId

string | null

The location of the user.

data.chatId

string

required

data.direction

enum<string>

required

Available options:

INBOUND,

OUTBOUND

data.status

enum<string>

required

Available options:

CREATED,

ONGOING,

TRANSFERRED,

DISCONNECTED,

FAILED,

FINISHED,

VOICEMAIL

data.sender

UserTiny · object

Show child attributes

data.sender.id

string

required

The unique identifier for the user.

data.sender.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.sender.firstName

string | null

The user's first name.

data.sender.lastName

string | null

The user's last name.

data.sender.phoneNumber

string | null

The user's phone number.

data.sender.email

string | null

The user's email address.

data.sender.locationId

string | null

The location of the user.

data.completedDate

string<date-time> | null

data.retellCallId

string | null

data.disconnectionReason

string | null

data.pathToAudio

string | null

data.summary

string | null

data.context

Context · object

data.createdDate

string<date-time> | null

data.toolCalls

ToolCallSummary · object[]

Show child attributes

data.toolCalls.id

string

required

data.toolCalls.toolName

string

required

data.toolCalls.toolArguments

Toolarguments · object

required

data.toolCalls.createdDate

string<date-time>

required

data.toolCalls.callId

string | null

data.toolCalls.messageId

string | null

data.toolCalls.alertId

string | null

data.toolCalls.toolCallId

string | null

data.toolCalls.result

Result · object

data.toolCalls.toolCallDescription

string | null

data.toolCalls.hasBeenCalled

boolean

default:false

data.tags

TagSummary · object[]

Show child attributes

data.tags.name

string

required

data.tags.useForAlerts

boolean

required

data.tags.useForCalls

boolean

required

data.tags.id

string

required

data.tags.description

string | null

data.invoiceId

string | null

data.type

enum<string>

default:MANUAL

Available options:

MANUAL,

AI

data.locationId

string | null

total

integer

required

Get Unread Count Opt In From Automated Messages

⌘I

Getting Started

API

Tenant

Webhook

Headers

Query Parameters

Response