Get conversation

Overview

Use this API to get details of a completed conversation using conversation id.

Scope

Client application must have 'app.conversation.conversationmgr.interaction.manage' or 'app.conversation.conversationmgr.interaction.read' scope assigned.

SecurityoAuthClient

Request

path Parameters

required

string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079

Responses

200

Response for fetch conversation API

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/conversations/{id}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"id": "21822806-88c3-43b3-8eed-097b4f0d68a7",
"account": {"address": "1000",
"channel": {"type": "web_chat"
}
},
"conversationContact": "phone.mobile",
"entryPoint": {"id": "1000"
},
"customer": {"name": "John smith",
"type": "individual",
"attributes": [{"name": "type",
"value": "individual"
}
],
"contacts": {"contact": [{"type": "phone",
"subType": "mobile",
"address": "123456788"
},
{"type": "email",
"address": "johnsmith@example.com"
}
]
}
},
"messages": {"message": [{"id": "c3bd352c-68ca-43ed-a328-89e125332f5d",
"messageId": "96ea3afb-b462-2ea4-7aed-500020a648f3",
"type": {"value": "text"
},
"content": {"text": "I need help with my order.",
"redact": false
},
"sender": {"type": "customer",
"participant": {"name": "John smith"
}
},
"recipients": {"recipient": [{"type": "custom_bot",
"participant": {"name": "custom_bot_participant"
}
}
]
},
"status": "sent",
"created": "2021-03-30T22:58:09.533Z",
"sent": "2021-03-30T22:58:11.549Z"
},
{"id": "a08c022c-123b-4c90-9cba-12927981e347",
"messageId": "1db8cee5-c7af-484a-bd6e-57d38c53193a",
"type": {"value": "text"
},
"content": {"text": "Please enter your order number",
"redact": false
},
"sender": {"type": "custom_bot",
"participant": {"name": "custom_bot_participant"
}
},
"recipients": {"recipient": [{"type": "customer"
}
]
},
"status": "sent",
"created": "2021-03-30T22:58:11.709Z",
"sent": "2021-03-30T22:58:13.726Z"
},
{"id": "6bb5190a-a6f2-4069-a039-0f780fdf8a03",
"messageId": "c3bd352c-68ca-43ed-a328-89e125332f5d",
"type": {"value": "text"
},
"content": {"text": "12354326875",
"redact": false
},
"sender": {"type": "customer",
"participant": {"name": "John smith"
}
},
"recipients": {"recipient": [{"type": "custom_bot",
"participant": {"name": "custom_bot_participant"
}
}
]
},
"status": "sent",
"created": "2021-03-30T22:58:26.752Z",
"sent": "2021-03-30T22:58:28.209Z"
}
]
}
}