查询多个消息会话信息

查询多个消息会话的详细信息。

请求 URL

GET {base_url}/{api_path}/message_session/query?access_token={access_token}

请求参数

参数 是否必填 类型 说明
ids 是 String 消息会话的唯一 ID。
注：
  • 使用半角逗号 , 分隔多个 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
list Array<Session_Info> 消息会话详情。
Session_Info
参数 类型 说明
id Integer 消息会话的唯一 ID。
channel_type String 消息会话使用的消息渠道类型。
  • sms：SMS 短信渠道。
  • whatsapp：WhatsApp 消息渠道。
  • facebook：Facebook 消息渠道。
  • livechat：在线咨询渠道。
channel_name String 消息会话使用的消息渠道名称。
did_number String 消息会话使用的 DID 号码。
to_number String 外部客户的 ID 或电话号码。
origin String 消息会话的来源。
  • campaign：该会话由消息群发活动创建。
注： 若返回为空，则表示该会话由分机用户或第三方分析平台通过 API 创建。
page_name String Facebook 公共主页名称。
注： 此参数仅在查询 Facebook 会话时返回信息。
website_domain String 嵌入在线咨询插件的网站的域名。
注： 此参数仅在查询在线咨询 (Live Chat)会话时返回信息。
pre_chat_form Object<PreChat_Form> 外部客户填写的预聊天表单的内容。
注： 此参数仅在查询在线咨询 (Live Chat)会话时返回信息。
user_info Object<Customer_Info> 消息会话中外部客户的信息。
participants Array<Agent_Info> 消息会话中消息队列坐席的信息。
注： 此参数仅在消息会话被分配给消息队列且未被接管时才会返回信息。
PreChat_Form
参数 类型 说明
name String 用户名。
email String 邮箱地址。
phone String 电话号码。
first_name String 姓氏。
last_name String 名称。
Customer_Info
参数 类型 说明
user_id Integer 消息会话中内部用户的 ID。
注： 此参数始终返回 0。
user_no String 外部客户的 ID 或电话号码。
user_type Integer 外部客户的类型。
  • 2：SMS 用户。
  • 3：WhatsApp 用户。
  • 4：Facebook 用户。
  • 5：在线咨询 (Live Chat) 用户。
  • 8：消息群发活动收信人。
avatar String 外部客户头像的 ID。
username String 外部客户用户名。
Agent_Info
参数 类型 说明
user_id Integer 坐席分机 ID。
user_no String 坐席分机号码。
user_type Integer 用户类型。
  • 1：分机号码。
avatar String 坐席头像的 ID。
username String 坐席分机名称。

示例

请求示例

查询两个消息会话 (ID：3035 & 3073) 的详细信息。

GET /openapi/v1.0/message_session/query?access_token=PqR954uFQ5h36g43blSG6rg9HboK4Pdz&ids=3035,3073 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "list": [
        {
            "id": 3035,
            "channel_type": "sms",
            "did_number": "+15551234567",
            "to_number": "+18665554444",
            "page_name": "",
            "user_info": {
                "user_id": 0,
                "user_no": "+18665554444",
                "user_type": 2,
                "avatar": "",
                "username": "John Doe"
            },
            "channel_name": "General SMS channel",
            "website_domain": "",
            "origin": "",
            "participants": null
        },
        {
            "id": 3073,
            "channel_type": "sms",
            "did_number": "+14443335555",
            "to_number": "+17778889999",
            "page_name": "",
            "user_info": {
                "user_id": 0,
                "user_no": "+17778889999",
                "user_type": 2,
                "avatar": "",
                "username": ""
            },
            "channel_name": "Apidaze SMS channel",
            "website_domain": "",
            "origin": "",
            "participants": null
        }        
    ]
}