List conversations

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

List all conversations associated with your application. This endpoint required an admin JWT. To find all conversations for the currently logged in user, see GET /users/:id/conversations

date_startstring dateTime

Example:2018-01-01 10:00:00

Return the records that occurred after this point in time.

date_endstring dateTime

Example:2018-01-01 12:00:00

Return the records that occurred before this point in time.

page_sizenumber

The amount of records returned in this response

Example:50

Return this amount of records in the response

record_indexnumber

Return page_size amount of conversations from this index in the response. That is, if your request returns 300 conversations, set record_index to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first page_size calls.

Return calls from this index in the response

order'asc' | 'desc' | 'ASC' | 'DESC'

Return the records in ascending or descending order.

Response

List Conversations Response Payload Object.

countnumber required

The total number of records returned by your request.

page_sizenumber required

The amount of records returned in this response

record_indexnumber required

Return page_size amount of conversations from this index in the response. That is, if your request returns 300 conversations, set record_index to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first page_size calls.

Example response

{
  "_embedded": {
    "conversations": [
      {
        "_links": {
          "self": {
            "href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391"
          }
        },
        "name": "customer_chat",
        "uuid": "CON-63f61863-4a51-4f6b-86e1-46edebio0391"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v0.1/conversations?page_size=2&record_index=10&"
    }
  },
  "page_size": 50
}

v1

List conversations

Query parameters

Response

Example response