查询单个消息会话的消息
查询指定消息会话中的消息。
请求 URL
GET {base_url}/{api_path}/message/get?access_token={access_token}请求参数
响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | Integer | 返回错误码。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
|
| errmsg | String | 返回信息。
|
| data | Object<Messages> | 查询到的消息的详情。 |
- Messages
-
参数 类型 说明 session_id Integer 消息会话的唯一 ID。 records Array<Msg_Record> 消息记录。
示例
请求示例
查询在线咨询会话 (ID：2874) 中的消息。
GET /openapi/v1.0/message/get?page_size=10&access_token=d8lxvXmhnvMoqw79pUfsdJXyHal6jqIT&id=2874 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"data": {
"session_id": 2874,
"records": [
{
"session_id": 2874,
"msg_id": 9263,
"delivery_status": 1,
"sender": {
"user_id": 0,
"user_no": "1cc0546496ae42eabf50a54a97fff976",
"user_type": 5,
"avatar": "",
"username": "Website Visitor"
},
"msg_type": 7,
"msg_body": "The session has been closed by visitor.",
"msg_files": "",
"send_time": 1753238892,
"param": "",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753238892,
"whatsapp_msg_param": "",
"msg_kind": 0
},
{
"session_id": 2874,
"msg_id": 9211,
"delivery_status": 1,
"sender": {
"user_id": 39,
"user_no": "59996",
"user_type": 1,
"avatar": "HEEsqLBtF2VJ4wV85f2ef07f-15ab-4e62-bffb-1200a54a3209",
"username": "Jane Smith"
},
"msg_type": 6,
"msg_body": "Jane Smith has transferred the session to Tech Support queue.",
"msg_files": "",
"send_time": 1753232835,
"param": "{\"from\":\"Jane Smith\",\"to\":\"Tech Support queue\",\"to_id\":6,\"to_type\":\"queue\"}",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753232835,
"whatsapp_msg_param": "",
"msg_kind": 0
},
{
"session_id": 2874,
"msg_id": 9209,
"delivery_status": 1,
"sender": {
"user_id": 39,
"user_no": "59996",
"user_type": 1,
"avatar": "HEEsqLBtF2VJ4wV85f2ef07f-15ab-4e62-bffb-1200a54a3209",
"username": "Jane Smith"
},
"msg_type": 8,
"msg_body": "Jane Smith initiates a call to the Website Visitor. Call duration: 00:05:00. CDR ID: 20250723090642A9FDF.",
"msg_files": "",
"send_time": 1753232811,
"param": "{\"from\":\"Jane Smith\",\"to\":\"Website Visitor\",\"to_type\":5,\"to_member_id\":10832,\"cdr_uid\":\"20250723090642A9FDF\",\"duration\":\"00:05:00\"}",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753232811,
"whatsapp_msg_param": "",
"msg_kind": 0
},
{
"session_id": 2874,
"msg_id": 9208,
"delivery_status": 1,
"sender": {
"user_id": 0,
"user_no": "1cc0546496ae42eabf50a54a97fff976",
"user_type": 5,
"avatar": "",
"username": "Website Visitor"
},
"msg_type": 8,
"msg_body": "Website Visitor initiates a call to the Jane Smith. Call duration: 00:03:02. CDR ID: 20250723090632258BB.",
"msg_files": "",
"send_time": 1753232798,
"param": "{\"from\":\"Website Visitor\",\"to\":\"Jane Smith\",\"to_type\":1,\"to_member_id\":10833,\"cdr_uid\":\"20250723090632258BB\",\"duration\":\"00:03:02\"}",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753232798,
"whatsapp_msg_param": "",
"msg_kind": 0
},
{
"session_id": 2874,
"msg_id": 9207,
"delivery_status": 1,
"sender": {
"user_id": 39,
"user_no": "59996",
"user_type": 1,
"avatar": "HEEsqLBtF2VJ4wV85f2ef07f-15ab-4e62-bffb-1200a54a3209",
"username": "Jane Smith"
},
"msg_type": 5,
"msg_body": "Jane Smith picked up the session from message queue Customer Query queue",
"msg_files": "",
"send_time": 1753232778,
"param": "{\"from\":\"Customer Query queue\",\"from_id\":4,\"to\":\"Jane Smith\"}",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753232778,
"whatsapp_msg_param": "",
"msg_kind": 0
},
{
"session_id": 2874,
"msg_id": 9206,
"delivery_status": 1,
"sender": {
"user_id": 0,
"user_no": "1cc0546496ae42eabf50a54a97fff976",
"user_type": 5,
"avatar": "",
"username": "Website Visitor"
},
"msg_type": 0,
"msg_body": "I'm not receiving email notifications from your system. Can you check this for me?",
"msg_files": "",
"send_time": 1753232747,
"param": "",
"send_error": "",
"send_error_msg": "",
"tag": "",
"receive_time": 1753232747,
"whatsapp_msg_param": "",
"msg_kind": 0
}
]
}
}