latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

messages

List messages from a conversation

Returns the first 100 messages in a specific conversation by default. Use limit_count and last_id_returned to paginate through results.

Permission: Conversations Read required.

Monitoring: Optional. With Monitoring OFF, only non-archived messages are returned. With Monitoring ON, all messages are returned including archived ones (you can also use the display_archived parameter).

get/conversations/{convId}/messages

Path parameters

convIdinteger required

The conversation ID

Query parameters

limit_countinteger
Example:100

Maximum number of results to return per page. Default: server-defined.

last_id_returnedinteger

Last id returned (To avoid duplicates we use it instead of limit_offset)

display_archivedboolean

A boolean to enable the archive display

Response

Successful operation — the message list is returned.

conversation_idinteger
is_sms_writeboolean

Allows to send SMS

type'INTERNAL' | 'EXTERNAL' | 'COLLABORATIVE'
namestring
purposestring
unread_messages_countinteger
last_id_returned_settedinteger
limit_count_settedinteger
total_messages_countinteger
message_list_countinteger
is_archivedboolean

Archived flag

creation_datestring date-time
update_datestring date-time

Example response

{
  "conversation_id": 222111,
  "type": "INTERNAL",
  "name": "My favorite conversation",
  "purpose": "Description of my favorite conversation",
  "limit_count_setted": 1,
  "total_messages_count": 8,
  "message_list_count": 54,
  "message_list": [
    {
      "message_id": 11223344,
      "user": {
        "user_id": 123456,
        "team_id": 123456,
        "initial": "PM",
        "color": "3CC8C8",
        "firstname": "Pauline",
        "lastname": "Martin",
        "company": "Ringover",
        "email": "pauline.martin@ringover.com",
        "picture": "https://cdn77.ringover.com/img/users/default.jpg",
        "concat_name": "Pauline Martin"
      },
      "contact": {
        "contact_id": 654321,
        "is_shared": true,
        "social_service_id": "00P7U000015Ei75YBX",
        "firstname": "John",
        "lastname": "Do",
        "company": "DoeCompany",
        "concat_name": "John Doe",
        "color": "3CC8C8",
        "initial": "JD",
        "creation_date": "2018-08-12T12:12:40.53Z",
        "numbers": [
          331797500010
        ]
      },
      "number": {
        "raw": 184800000,
        "country_code": "33",
        "country": "FR",
        "e164": "+33184800000",
        "international": "+33 1 84 80 00 00",
        "international_alt": "33184800000",
        "national": "01 84 80 00 00",
        "national_alt": "0184800000",
        "rfc3966": "tel:+33-1-84-80-00-00"
      },
      "buffer": "Hello World",
      "direction": "IN",
      "archive_date": "2019-03-11T12:20:50.52Z",
      "creation_date": "2018-12-21T12:20:50.52Z",
      "update_date": "2018-12-21T12:20:50.52Z"
    }
  ],
  "creation_date": "2018-06-12T23:23:40.99Z",
  "update_date": "2019-02-12T12:20:50.52Z"
}