GET

https://api.vida.dev

/
api
/
v2
/
messages
/
recent
curl --request GET \
  --url https://api.vida.dev/api/v2/messages/recent
[
  {
    "from": 1234567890,
    "fromUser": "user_test",
    "to": 878589,
    "toUser": "support2",
    "rate": 123,
    "usdRate": 123,
    "timestamp": 1718463395,
    "date": "2024-06-15T14:56:35.000Z",
    "message": "Hi there! Lyle is currently unavailable. Could you please let me know the nature of your call or message and any specific details you'd like me to pass on to him? Thanks!",
    "content-type": "text/plain",
    "disposition-notification": "<string>",
    "roomId": "1:878589",
    "status": "success",
    "attachments": [
      {
        "content-type": "audio/mp3",
        "filename": "mp3",
        "content-url": "https://example.com/media/recording.mp3",
        "attachmentType": "call"
      }
    ],
    "isLive": true,
    "aiAgent": true,
    "aiReward": "<string>",
    "aiRewardUsd": 123,
    "aiLeadRating": 123,
    "aiLeadRatingReason": "<string>",
    "aiAgentOverride": "<string>",
    "gift": true,
    "source": "email",
    "uuid": "a4977f49-80a6-41f0-9add-93a270cdd781",
    "campaignId": "campa25290ee54602fbcb545d033c1a15ba12",
    "fromNumber": "+15125551234",
    "toNumber": "+15125559876",
    "notify": true,
    "targetInbox": "inbox",
    "type": "call",
    "duration": 9,
    "direction": "inbound",
    "missedCall": true,
    "bypassAgent": true,
    "cnamSpam": true,
    "selfCall": true,
    "callingUserIsContact": true,
    "agentOutcome": "<string>",
    "summary": "<string>",
    "callDialog": [
      {
        "role": "assistant",
        "content": "Hello! This is the answering assistant. How can I help you?"
      }
    ],
    "campaign": true,
    "diversion": "<string>",
    "voicemailRecording": "<string>",
    "eventType": "inbound-call",
    "forcedCampaign": true
  }
]

Authorizations

token
string
queryrequired

Vida API Token

Response

200 - application/json
from
number

From User Id

fromUser
string

From User Name

to
number

To User Id

toUser
string

To User Name

rate
number

Rate associated with the message

usdRate
number

USD rate associated with the message

timestamp
number

Epoch of the last message's timestamp

date
string

Friendly Date

message
string

Message text

content-type
string

Content type of the message

disposition-notification
string

Disposition notification status

roomId
string

Room Id

status
string

Status of the message

attachments
object[]

Array of media attachment URLs

isLive
boolean

Whether the message is live

aiAgent
boolean

Whether an AI agent is involved

aiReward
string

AI reward status

aiRewardUsd
number

AI reward in USD

aiLeadRating
number

AI lead rating

aiLeadRatingReason
string

Reason for AI lead rating

aiAgentOverride
string

AI agent override status

gift
boolean

If this message included a monetary gift

source
string

Source medium for the message

uuid
string

Unique ID for message

campaignId
string

Campaign ID associated with the message

fromNumber
string

Phone number of the sender

toNumber
string

Phone number of the recipient

notify
boolean

Notification flag

targetInbox
string

Target inbox

type
string

Type of message

duration
number

Duration of the call

direction
string

Direction of the call

missedCall
boolean

Whether it was a missed call

bypassAgent
boolean

Whether the agent was bypassed

cnamSpam
boolean

Whether the call was marked as spam by CNAM

selfCall
boolean

Whether the call was self-initiated

callingUserIsContact
boolean

Whether the calling user is a contact

agentOutcome
string

Outcome from the agent

summary
string

Summary of the message

callDialog
object[]

Array of dialog entries with roles and contents

campaign
boolean

Campaign status

diversion
string

Diversion status

voicemailRecording
string

Voicemail recording details

eventType
string

Type of event

forcedCampaign
boolean

Forced campaign flag

List Junk InboxFetch Room Messages