v1

latestOpenAPI 3.0.02026-07-14235231.7 KB

event

List events

This endpoint is DEPRECATED. Please use /v0.2/events.

get/conversations/{conversation_id}/events

Response

Retrieve Events Response Payload Object

bodyEventBody required

Event Body

fromstring

Member ID

hrefstring url required

A link towards a conversation event included in Conversation API

idstring required

Event id. This is a progressive integer

state'invited' | 'joined' | 'left' | 'unknown'

The state that the member is in. Possible values are invited, joined, left, or unknown

timestampstring required

Time of creation

tostring

Member ID

typestring required

Event type

Example response

[
  {
    "body": {
      "text": "My Text"
    },
    "from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
    "href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1",
    "id": "5",
    "state": "invited",
    "timestamp": "2020-01-01T14:00:00.00Z",
    "to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
    "type": "text"
  }
]