Messaging
List Priority Inbox
API Documentation
Authorization
Agents
Phone Numbers
SIP
Messaging
Knowledge
Accounts
Billing
Messaging
List Priority Inbox
Fetch rooms in 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
Example:
20
Example:
0
Example:
100
Room Id
Example:
"3:15"
Other users full name
Example:
"John Doe"
userId of other user
Example:
15
Link to other users image
Example:
"https://somepublicURl"
Other user Vida Phone Number
Example:
"+12165169995"
If the other user is registered on Vida platform or offnet
Example:
false
Display name for unregistered user which is often their phone number or email
Example:
"+15125551234"
Indicator which inbox on the other user side the conversation is in
Example:
"+15125551234"
Last message text in the room
Example:
"That was awesome, thanks!"
Epoch of the last messages timestamp
Example:
1710510072
Agent Id that handled the message
Example:
"campa....."
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....."
}
]
}