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

9da73dd2f99e

conversations

List members of a conversation

Returns all members of a specific conversation.

Permission: Conversations Read required.

Monitoring: Optional. With Monitoring OFF, you can only list members of your own conversations. With Monitoring ON, you can list members of any conversation within your supervision scope.

get/conversations/{convId}/members

Path parameters

convIdinteger required

The identifer of the conversation

Response

Successful operation — the member list is returned.

conversation_idinteger
list_member_countinteger nullable
list_internal_member_countinteger nullable
list_external_member_countinteger nullable

Example response

{
  "conversation_id": 222111,
  "list_member": [
    {
      "user": {
        "user_id": 654321,
        "initial": "JD",
        "color": "3CC8C8",
        "firstname": "John",
        "lastname": "Doe",
        "company": "MyCompany",
        "concat_name": "John Doe",
        "email": "myemail@domain.com",
        "picture": "https://my.image.com/default.jpg",
        "is_sms_write": true,
        "is_administrator": true
      },
      "ivr": {
        "id": 657657,
        "name": "MyIVR",
        "scenario_id": 777777,
        "color": "FFD54F"
      },
      "group": {
        "id": 999999,
        "name": "myIVR",
        "color": "FFD54F"
      },
      "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"
      },
      "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
        ]
      },
      "picture": "https://my.image.com/default.jpg"
    }
  ],
  "list_member_count": 1,
  "list_internal_member": [
    {
      "user": {
        "user_id": 654321,
        "initial": "JD",
        "color": "3CC8C8",
        "firstname": "John",
        "lastname": "Doe",
        "company": "MyCompany",
        "concat_name": "John Doe",
        "email": "myemail@domain.com",
        "picture": "https://my.image.com/default.jpg",
        "is_sms_write": true,
        "is_administrator": true
      },
      "ivr": {
        "id": 657657,
        "name": "MyIVR",
        "scenario_id": 777777,
        "color": "FFD54F"
      },
      "group": {
        "id": 999999,
        "name": "myIVR",
        "color": "FFD54F"
      },
      "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"
      },
      "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
        ]
      },
      "picture": "https://my.image.com/default.jpg"
    }
  ],
  "list_external_member": [
    {
      "user": {
        "user_id": 654321,
        "initial": "JD",
        "color": "3CC8C8",
        "firstname": "John",
        "lastname": "Doe",
        "company": "MyCompany",
        "concat_name": "John Doe",
        "email": "myemail@domain.com",
        "picture": "https://my.image.com/default.jpg",
        "is_sms_write": true,
        "is_administrator": true
      },
      "ivr": {
        "id": 657657,
        "name": "MyIVR",
        "scenario_id": 777777,
        "color": "FFD54F"
      },
      "group": {
        "id": 999999,
        "name": "myIVR",
        "color": "FFD54F"
      },
      "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"
      },
      "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
        ]
      },
      "picture": "https://my.image.com/default.jpg"
    }
  ]
}