Messaging
List Junk Inbox
Messaging
List Junk Inbox
Fetch rooms in junk inbox
GET
https://api.vida.dev
/
api
/
v2
/
junkConversations
baseUrl
string
baseUrl
string
Production API Root
token
string
*
token
Required
string
Vida API Token
pagination
boolean
*
pagination
Required
boolean
Whether to provide pagination
page
number
page
number
Page number to fetch
pageSize
number
pageSize
number
How many rooms per page
unread
boolean
unread
boolean
Only return unread rooms
curl --request GET \
--url https://api.vida.dev/api/v2/junkConversations
{
"pageSize": 20,
"pageNumber": 123,
"totalRooms": 100,
"rooms": [
{
"roomId": "3:15",
"name": "John Doe",
"id": 15,
"image": "https://somepublicURl",
"vidaPhoneNumber": "+12165169995",
"unregistered": true,
"unregisteredDisplayName": "+15125551234",
"destinationInboxType": "+15125551234",
"lastMessage": "That was awesome, thanks!",
"lastMessageTimestamp": 1710510072,
"chatAgentCampaignId": "campa....."
}
]
}
Authorizations
token
string
queryrequiredVida API Token
Query Parameters
pagination
boolean
requiredWhether to provide pagination
page
number
Page number to fetch
pageSize
number
How many rooms per page
unread
boolean
Only return unread rooms
Response
200 - application/json
pageSize
number
pageNumber
number
totalRooms
number
rooms
object[]
rooms.roomId
string
Room Id
rooms.name
string
Other users full name
rooms.id
number
userId of other user
rooms.image
string
Link to other users image
rooms.vidaPhoneNumber
string
Other user Vida Phone Number
rooms.unregistered
boolean
If the other user is registered on Vida platform or offnet
rooms.unregisteredDisplayName
string
Display name for unregistered user which is often their phone number or email
rooms.destinationInboxType
string
Indicator which inbox on the other user side the conversation is in
rooms.lastMessage
string
Last message text in the room
rooms.lastMessageTimestamp
number
Epoch of the last messages timestamp
rooms.chatAgentCampaignId
string
Agent Id that handled the message
curl --request GET \
--url https://api.vida.dev/api/v2/junkConversations
{
"pageSize": 20,
"pageNumber": 123,
"totalRooms": 100,
"rooms": [
{
"roomId": "3:15",
"name": "John Doe",
"id": 15,
"image": "https://somepublicURl",
"vidaPhoneNumber": "+12165169995",
"unregistered": true,
"unregisteredDisplayName": "+15125551234",
"destinationInboxType": "+15125551234",
"lastMessage": "That was awesome, thanks!",
"lastMessageTimestamp": 1710510072,
"chatAgentCampaignId": "campa....."
}
]
}