API Documentation
Authorization
Agents
Phone Numbers
SIP
Knowledge
Accounts
Billing
API Reference
Messaging
List priority inbox
GET
/
api
/
v2
/
conversations
curl --request GET \
--url https://api.vida.dev/api/v2/conversations{
"pageSize": 20,
"pageNumber": 0,
"totalRooms": 100,
"rooms": [
{
"roomId": "3:15",
"name": "John Doe",
"id": 15,
"image": "https://somepublicURl",
"vidaPhoneNumber": "+12165169995",
"unregistered": false,
"unregisteredDisplayName": "+15125551234",
"destinationInboxType": "+15125551234",
"lastMessage": "That was awesome, thanks!",
"lastMessageTimestamp": 1710510072,
"chatAgentCampaignId": "campa....."
}
]
}Authorizations
Vida API Token
Query Parameters
Whether to provide pagination
Page number to fetch
How many rooms per page
Only return unread rooms
Response
200 - application/json
Successful response
Room Id
Other users full name
userId of other user
Link to other users image
Other user Vida Phone Number
If the other user is registered on Vida platform or offnet
Display name for unregistered user which is often their phone number or email
Indicator which inbox on the other user side the conversation is in
Last message text in the room
Epoch of the last messages timestamp
Agent Id that handled the message
curl --request GET \
--url https://api.vida.dev/api/v2/conversations{
"pageSize": 20,
"pageNumber": 0,
"totalRooms": 100,
"rooms": [
{
"roomId": "3:15",
"name": "John Doe",
"id": 15,
"image": "https://somepublicURl",
"vidaPhoneNumber": "+12165169995",
"unregistered": false,
"unregisteredDisplayName": "+15125551234",
"destinationInboxType": "+15125551234",
"lastMessage": "That was awesome, thanks!",
"lastMessageTimestamp": 1710510072,
"chatAgentCampaignId": "campa....."
}
]
}