A Conversation is a collection of messages with one or more participants (i.e., users) started at a particular point in time.
1.0.17
1.0.18
Name | Type | Description |
---|---|---|
conversationType | string | Read-only one-on-one (two people) or group (more than two) |
EID | EID | Unique entity identifier |
icon | URI | Since 1.0.18 Custom icon |
iconThumbnailUrl | URI | Since 1.0.18 Custom icon thumbnail url |
lastUpdated | datetime | Read-only Date of the last message to the conversation (ISO 8601 compliant) |
numParticipants | integer | Since 1.0.17 Read-only Number of active participants |
numUnreadMessages | integer | Read-only Number of unread messages in the conversation |
readUntil | datetime | Read-only Date of the last message that was read (ISO 8601 compliant) |
started | datetime | Read-only Date the conversation was started (ISO 8601 compliant) |
title | string | Since 1.0.18 Custom title |
Relation | Resource | Description |
---|---|---|
initiator | user | User that started the conversation |
lastMessage | message | The most recent message in the conversation |
messages | message | Messages that are part of the conversation |
participants | user | Users that take part in the conversation |
{
"_links": {
"self": {
"href": "https://api.speakap.io/networks/FEDCBA0987654321/conversations/?user=ABCDEF0123456789"
},
"participants": [
{
"name": "Jane Doe",
"href": "https://api.speakap.io/networks/FEDCBA0987654321/users/ABCDEF0123456789/"
},
{
"name": "Alan Smithee",
"href": "https://api.speakap.io/networks/FEDCBA0987654321/users/9876543210FEDCBA/"
}
],
"initiator": {
"href": "https://api.speakap.io/networks/FEDCBA0987654321/users/ABCDEF0123456789/"
},
"messages": {
"href": "https://api.speakap.io/networks/FEDCBA0987654321/messages/?conversation=1234567890ABCDEF"
},
"icon": {
"href": "https://api.speakap.io/networks/FEDCBA0987654321/messages/ABCDEF0123456789/"
}
},
"EID": "1234567890ABCDEF",
"conversationType": "one-on-one",
"started": "2013-03-13T16:59:24.123+01:00",
"lastUpdated": "2013-03-13T16:59:24.123+01:00",
"title": "Jane and Alan",
"iconThumbnailUrl": "http://vault.speakap.com/file/1234567890ABCDEF",
"numUnreadMessages": 0,
"numParticipants": 2,
}