v1
latestOpenAPI 3.0.02026-07-1441717.8 KBevent
List Events
get/conversations/{conversation_id}/events
Path parameters
conversation_idstring required
The ID of the conversation
Query parameters
page_sizeinteger
The number of results returned per page. The default value is 10. The maximum value is 100.
order'asc' | 'desc'
Show the most (desc) / least (asc) recently created entries first
cursorstring
The cursor to start returning results from.
You are not expected to provide this manually, but to follow the url provided in _links.next.href in the response which contains a cursor value
start_idstring
The ID to start returning events at
end_idstring
The ID to end returning events at
event_typestring
The type of event to search for. Does not currently support custom events
Response
OK
Example response
{
"_embedded": {
"data": {
"events": [
{
"body": {
"text": "Hello World"
},
"conversation_id": "CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625",
"type": "text",
"_links": {
"self": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events/9"
}
},
"from": "MEM-afe887d8-d587-4280-9aae-dfa4c9227d5e",
"id": 9,
"timestamp": "2019-09-12T19:49:21.823Z"
}
]
}
},
"_links": {
"first": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10"
},
"next": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=4db03d9254d1cdaecc7b1fc15b6bf1a81f3d3151191d784f1327893f8dc96416"
},
"prev": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=84963f79fd25785be9706bd38bfd30c264f71964fa4edc8d8b4dd5f30bbd9f7c"
},
"self": {
"href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=a30e3b7a3dcda1434f64bbb1a5fa489b"
}
},
"page_size": 10
}