conversations
Get a specific conversation
Retrieves information about a specific conversation. Only the last message is included; use the messages endpoint to retrieve the full message history.
Permission: Conversations Read required.
Monitoring: Optional. With Monitoring OFF, you can only access your own conversations. With Monitoring ON, you can access any conversation within your supervision scope.
get/conversations/{convId}
Path parameters
convIdinteger required
Example:123456
The identifier of the conversation
Response
Successful operation — the conversation details are returned.
Example response
{
"conversation_id": 222111,
"type": "INTERNAL",
"tags": [
"tag1",
"tag2"
],
"star": [
"STAR1"
],
"name": "My favorite conversation",
"purpose": "Description of my favorite conversation",
"user_list": {
"user_id": 123456,
"initial": "PM",
"color": "3CC8C8",
"firstname": "Pauline",
"lastname": "Martin",
"company": "Ringover",
"concat_name": "Pauline Martin",
"email": "pauline.martin@ringover.com",
"picture": "https://cdn77.ringover.com/img/users/default.jpg"
},
"internal": [
{
"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"
}
],
"external": [
{
"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"
}
],
"last_message": {
"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"
},
"total_messages_count": 8,
"creation_date": "2018-06-12T23:23:40.99Z",
"update_date": "2019-02-12T12:20:50.52Z"
}