GET
/
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": 0,
    "usdRate": 0,
    "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": null,
    "roomId": "1:878589",
    "status": "success",
    "attachments": [
      {
        "content-type": "audio/mp3",
        "filename": "mp3",
        "content-url": "https://example.com/media/recording.mp3",
        "attachmentType": "call"
      }
    ],
    "isLive": false,
    "aiAgent": true,
    "aiReward": null,
    "aiRewardUsd": null,
    "aiLeadRating": null,
    "aiLeadRatingReason": null,
    "aiAgentOverride": null,
    "gift": false,
    "source": "email",
    "uuid": "a4977f49-80a6-41f0-9add-93a270cdd781",
    "campaignId": "campa25290ee54602fbcb545d033c1a15ba12",
    "fromNumber": "+15125551234",
    "toNumber": "+15125559876",
    "notify": false,
    "targetInbox": "inbox",
    "type": "call",
    "duration": 9,
    "direction": "inbound",
    "missedCall": false,
    "bypassAgent": false,
    "cnamSpam": false,
    "selfCall": true,
    "callingUserIsContact": false,
    "agentOutcome": null,
    "summary": null,
    "callDialog": [
      {
        "role": "assistant",
        "content": "Hello! This is the answering assistant. How can I help you?"
      }
    ],
    "campaign": true,
    "diversion": null,
    "voicemailRecording": null,
    "eventType": "inbound-call",
    "forcedCampaign": true
  }
]

Authorizations

​
token
string
query
required

Vida API Token

Response

200 - application/json
Successful response
​
from
number

From User Id

Example:

1234567890

​
fromUser
string

From User Name

Example:

"user_test"

​
to
number

To User Id

Example:

878589

​
toUser
string

To User Name

Example:

"support2"

​
rate
number

Rate associated with the message

Example:

0

​
usdRate
number

USD rate associated with the message

Example:

0

​
timestamp
number

Epoch of the last message's timestamp

Example:

1718463395

​
date
string

Friendly Date

Example:

"2024-06-15T14:56:35.000Z"

​
message
string

Message text

Example:

"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
string

Content type of the message

Example:

"text/plain"

​
disposition-notification
string

Disposition notification status

Example:

null

​
roomId
string

Room Id

Example:

"1:878589"

​
status
string

Status of the message

Example:

"success"

​
attachments
object[]

Array of media attachment URLs

​
isLive
boolean

Whether the message is live

Example:

false

​
aiAgent
boolean

Whether an AI agent is involved

Example:

true

​
aiReward
string

AI reward status

Example:

null

​
aiRewardUsd
number

AI reward in USD

Example:

null

​
aiLeadRating
number

AI lead rating

Example:

null

​
aiLeadRatingReason
string

Reason for AI lead rating

Example:

null

​
aiAgentOverride
string

AI agent override status

Example:

null

​
gift
boolean

If this message included a monetary gift

Example:

false

​
source
string

Source medium for the message

Example:

"email"

​
uuid
string

Unique ID for message

Example:

"a4977f49-80a6-41f0-9add-93a270cdd781"

​
campaignId
string

Campaign ID associated with the message

Example:

"campa25290ee54602fbcb545d033c1a15ba12"

​
fromNumber
string

Phone number of the sender

Example:

"+15125551234"

​
toNumber
string

Phone number of the recipient

Example:

"+15125559876"

​
notify
boolean

Notification flag

Example:

false

​
targetInbox
string

Target inbox

Example:

"inbox"

​
type
string

Type of message

Example:

"call"

​
duration
number

Duration of the call

Example:

9

​
direction
string

Direction of the call

Example:

"inbound"

​
missedCall
boolean

Whether it was a missed call

Example:

false

​
bypassAgent
boolean

Whether the agent was bypassed

Example:

false

​
cnamSpam
boolean

Whether the call was marked as spam by CNAM

Example:

false

​
selfCall
boolean

Whether the call was self-initiated

Example:

true

​
callingUserIsContact
boolean

Whether the calling user is a contact

Example:

false

​
agentOutcome
string

Outcome from the agent

Example:

null

​
summary
string

Summary of the message

Example:

null

​
callDialog
object[]

Array of dialog entries with roles and contents

​
campaign
boolean

Campaign status

Example:

true

​
diversion
string

Diversion status

Example:

null

​
voicemailRecording
string

Voicemail recording details

Example:

null

​
eventType
string

Type of event

Example:

"inbound-call"

​
forcedCampaign
boolean

Forced campaign flag

Example:

true