Sign in

v1

latestOpenAPI 3.0.02026-07-14235231.7 KB
user

List user conversations

get/users/{user_id}/conversations

Response

List user conversations

display_namestring

The display name for the conversation. It does not have to be unique

hrefstring url

A link towards a resources included in Conversation API

idstring

The unique identifier for this conversation

image_urlstring url

A link to an image for conversations' and users' avatars

member_idstring

Member ID

namestring

Unique name for a conversation

sequence_numberinteger

the id of the last event of the conversation (event's id is an incremental number

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

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

Example response

[
  {
    "display_name": "Customer Chat",
    "href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391",
    "id": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
    "image_url": "https://example.com/image.png",
    "member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
    "name": "customer_chat",
    "state": "invited",
    "timestamp": {
      "created": "2020-01-01T14:00:00.00Z"
    }
  }
]