停更说明

因该版本对话记录接口陈旧,现已对该文档停止更新。请迁移到新版本对话记录接口

获取 IM 对话记录列表

该接口用于一次获取多个 IM 对话记录信息 频率限制 1 次/2 秒

请求方法

GET /api/v2/im/session

请求参数(Query String)

参数名 必填 说明
start_time 记录开始时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 0 点
end_time 记录结束时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 24 点
status 会话状态(close)
page 页码,从 1 开始,默认为 1
page_size 每页数量,默认 30,最大 1000

注意:

开始时间到结束时间最大时间段为 30 天;

start_time 和 end_time 默认查询的是对话的开始时间, 当 status=close 时按照对话结束时间进行查询;

start_time 和 end_time 的格式为:“YYYY-MM-DD hh:mm:ss”,也可省略时间部分:“YYYY-MM-DD”进行查询,此时,相当于使用YYYY-MM-DD 00:00:00进行查询。

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
size 整型 本次返回的数据数量
total 整型 数据总数
total_pages 整型 总页数
item 数组 对话记录列表,每个元素的内容参见IM 数据

示例

curl https://demo.udesk.cn/api/v2/im/session?page=1&page_size=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
  "status": 0,
  "message": "成功",
  "item": [
    {
      "session_id": 1,
      "sub_session_id": 1,
      "note_id": null,
      "customer_id": 1,
      "customer_name": "测试用户",
      "customer_custom_fields": {},
      "agent_id": 1,
      "agent_nick_name": "测试客服",
      "created_at": "2015-01-01 12:00:00",
      "closed_at": "2015-01-01 12:30:00",
      "resp_seconds": 7,
      "queue_seconds": "未排队",
      "sustain_seconds": 128,
      "survey_vote_id": 1357334,
      "belong_queue": "queue_company_6_group_331",
      "agent_msg_num": 0,
      "customer_msg_num": 0,
      "source": "reocar.udesk.com",
      "source_url": "https://demo.udeskt.cn/im_client/",
      "queue_start_time": "2015-01-01 11:14:49",
      "conversations_num_today": 4,
      "platform": "web",
      "organization_id": null,
      "last_response": "customer",
      "alert_num": 1,
      "alert_desc": "敏感词1次,响应超时,会话超时",
      "ticket_num": 2,
      "ticket_nos": "#140,#141",
      "im_web_plugin_id": 1,
      "sender": "customer",
      "active_guest": "agent",
      "menu_names": "导航菜单",
      "web_info": {
        "login_url": null,
        "session_url": "https://demo.udesk.cn/im_client/",
        "keyword": null,
        "src": "demo.udesk.cn",
        "src_url": "https://demo.udesk.cn/im_client/",
        "sys": "Win7",
        "bowser": "Chrome56",
        "generated_channel": null,
        "ip": "123.123.123.123"
      },
      "ticket_ids": []
    }
  ],
  "size": 1,
  "total": 1,
  "total_pages": 1
}

获取 IM 对话记录详情

该接口用于获取某个 IM 对话的详细信息

请求方法

GET /api/v2/im/im_sub_session

请求参数(Query String)

参数名 必填 说明
im_sub_session_id 一次会话的 id

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
im_sub_session_log 数组 对话记录详情,每个元素的内容参见IM 数据
im_log_infos 数组 聊天记录,详见im_log_infos参数说明

示例

请求

curl https://demo.udesk.cn/api/v2/im/im_sub_session?im_sub_session_id=14980761&sign=96689da0e96f12ebf67622413d7d86d5

返回

{
"status": 0,
"message": "成功",
"im_sub_session_log": [
  {
  "session_id": 8761,
  "sub_session_id": 14980761,
  "note_id": null,
  "customer_id": 117092,
  "customer_name": "xx",
  "customer_custom_fields": {},
  "agent_id": 862,
  "agent_nick_name": "xx_客服",
  "created_at": "2017-10-27 21:23:45",
  "closed_at": null,
  "resp_seconds": null,
  "queue_seconds": "未排队",
  "sustain_seconds": 9,
  "survey_vote_id": null,
  "platform": "微信",
  "belong_queue": "queue_company_6_group_271",
  "agent_msg_num": 0,
  "customer_msg_num": 1,
  "source": "微信-xx",
  "source_url": null,
  "queue_start_time": "2017-10-27 21:23:45",
  "conversations_num_today": 3,
  "agent_invite_vote_count": null,
  "search_keyword": null,
  "custom_channel": null,
  "last_response": "customer",
  "alert_num": 1,
  "alert_desc": "敏感词1次,响应超时,会话超时",
  "ticket_num": 2,
  "ticket_nos": "#140,#141",
  "im_web_plugin_id": 1,
  "sender": "customer",
  "active_guest": "agent",
  "weixin_info": {
    "name": "xx"
  }
  }
],
"im_log_infos": [
  {
  "id": 70161,
  "created_at": "2017-10-27 21:23:54",
  "sender": "customer",
  "user_id": 117092,
  "content": "{"type":"image","platform":"wechat","data":{"content":"https://dn-udeskim.qbox.me/022c4a12-4f83-492d-8e4d-5f04191e0058.jpg","duration":null,"origin_url":"https://api.weixin.qq.com/cgi-bin/media/get?access_token=Z7kg69qvIqh_5-jZmzmKVgbt3mXP4pvmiNpqt_risTXuF1tOGw2bax9YaSVVQM4PR0HH_q7Fpou3PlYJhujH09xJxQyNmIhGYank_vmMxnEPTJfAHAWAQ&media_id=ObkKKAP5qS8wtFgXi1C2VMHKCZxQxxSvg1YVH2uHuDB_1HfORtcRf_3L2FmCUvO6"}}",
  "session_id": 8761,
  "sub_session_id": 14980761,
  "survey_option_id": null
  },
  {
  "id": 70158,
  "created_at": "2017-10-27 21:23:45",
  "sender": "agent",
  "user_id": 862,
  "content": "{"type":"rich","platform":"wechat","data":{"content":"<p>客服xx_客服_昵称为您服务</p><p>啦啦啦啦啦-英语</p>","duration":null}}",
  "session_id": 8761,
  "sub_session_id": 14980761,
  "survey_option_id": null
  },
  {
  "id": 70157,
  "created_at": "2017-10-27 21:23:45",
  "sender": "customer",
  "user_id": 117092,
  "content": "{"type":"message","platform":"wechat","data":{"content":"有新的咨询进来了。","duration":null}}",
  "session_id": 8761,
  "sub_session_id": 14980761,
  "survey_option_id": null
  },
  {
  "id": 70159,
  "created_at": "2017-10-27 21:23:48",
  "sender": "agent",
  "user_id": 862,
  "content": "{"type":"message","platform":"wechat","data":{"content":"你好微信","duration":null}}",
  "session_id": 8761,
  "sub_session_id": 14980761,
  "survey_option_id": null
  },
  {
  "id": 70160,
  "created_at": "2017-10-27 21:23:52",
  "sender": "agent",
  "user_id": 862,
  "content": "{"type":"message","platform":"wechat","data":{"content":"普通","duration":null}}",
  "session_id": 8761,
  "sub_session_id": 14980761,
  "survey_option_id": null
 }
]
}

获取某一客户的聊天记录列表

该接口用于一次获取某一用户的聊天记录 频率限制 50 次/60 秒

请求方法

GET /api/v2/im/customer_im_logs

请求参数(Query String)

参数名 类型 必填 说明 限制
type 字符串 查询客户的条件类型 不超过 255 个字符
content 字符串 查询客户的条件内容 不超过 255 个字符
start_time 日期时间 记录开始时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 0 点
end_time 日期时间 记录结束时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 24 点
page 整型 页码,从 1 开始,默认为 1

条件类型和内容说明

取值 对应的 content 含义
id 客户 id
email 客户邮箱
cellphone 客户电话
token 客户外部唯一标识,对应值 open_api_token
weixin_open_id 客户微信 openid
weibo_id 客户微博 openid

注意;

记录开始时间到结束时间最大时间段为 90 天;

start_time 和 end_time 查询的是 im_sub_session 的创建时间;

start_time 和 end_time 的格式为:“YYYY-MM-DD hh:mm:ss”,也可省略时间部分:“YYYY-MM-DD”。

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
size 整型 本次返回的数据数量
total 整型 数据总数
total_pages 整型 总页数
item 数组 聊天记录列表,每个元素的内容如下

item 的内容

属性名 类型 说明
im_sub_session_id 整型 im_sub_session 的 id
im_log_infos 数组 im_sub_session 下的聊天记录,详情见下

im_log_infos 的内容

属性名 类型 说明
id 整型 im_log 的 id
created_at 日期时间 im_log 的创建时间
sender 字符串 消息发送者
user_id 整型 消息发送者的 id
nick_name 字符串 消息发送者的昵称
content 数组 聊天内容

示例

请求

curl https://demo.udesk.cn/api/v2/im/customer_im_logs?type=id&content=4173&start_time=2019-12-10&end_time=2020-01-01&sign=37eec33b035474b62785fd9caefbf0f8

返回数据

{
    "status": 0,
    "message": "成功",
    "item": [
        {
            "im_sub_session_id": 3852,
            "im_log_infos": [
                {
                    "id": 16834,
                    "created_at": "2017-10-18 16:08:34",
                    "sender": "customer",
                    "user_id": 4173,
                    "nick_name": "udesk测试",
                    "content": "{"type":"message","font":"","data":{"content":"有新的咨询进来了。"},"platform":"android","version":2,"auto":true}"
                },
                {
                    "id": 16836,
                    "created_at": "2017-10-18 16:08:35",
                    "sender": "agent",
                    "user_id": 2,
                    "nick_name": "Tom",
                    "content": "{"type":"close","font":"","data":{"content":"客服Tom关闭对话"},"platform":"android","version":2,"auto":true}"
                },
                {
                    "id": 16837,
                    "created_at": "2017-10-18 16:08:36",
                    "sender": "agent",
                    "user_id": 2,
                    "nick_name": "Tom",
                    "content": "{"type":"survey","font":"","data":{"content":"系统发送满意度调查"},"platform":"android","version":2,"auto":true}"
                }
            ],
        },
        {
            "im_sub_session_id": 3853,
            "im_log_infos": [
                {
                    "id": 16838,
                    "created_at": "2017-10-18 16:08:53",
                    "sender": "customer",
                    "user_id": 4173,
                    "nick_name": "udesk测试",
                    "content": "{"type":"message","font":"","data":{"content":"有新的咨询进来了。"},"platform":"android","version":2,"auto":true}"
                }
            ],
        }
    ],
    "size": 2,
    "total": 2,
    "total_pages": 1
}

获取聊天记录列表

该接口用于获取指定 IM 会话的聊天记录信息 频率限制 1 次/2 秒

请求方法

GET /api/v2/im/log

请求参数(Query String)

参数名 必填 说明
session_id IM 会话 id
start_time 记录开始时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 0 点
end_time 记录结束时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 24 点
page 页码,从 1 开始,默认为 1
page_size 每页数量,默认 30,最大 1000

start_time 和 end_time 查询的是聊天记录的创建时间; start_time 和 end_time 的格式为:“YYYY-MM-DD hh:mm:ss”,也可省略时间部分:“YYYY-MM-DD”。

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
size 整型 本次返回的数据数量
total 整型 数据总数
total_pages 整型 总页数
item 数组 聊天记录列表,每个元素的内容参见下表

item

属性名 类型 说明
id 整型 聊天记录id
created_at 字符串 聊天创建时间
sender 字符串 对话发起方 取值:"customer、agent、sys" 说明:"客户、客服、系统"
user_id 整型 发送人id
content 字符串 消息内容
session_id 整型 所属会话 id
sub_session_id 整型 所属子会话 id
survey_option_id 整型 选择的选项 id

示例

curl https://demo.udesk.cn/api/v2/im/log?session_id=1&page=1&page_size=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
  "status": 0,
  "message": "成功",
  "item": [
    {
      "id": 1,
      "created_at": "2015-01-01 12:00:00",
      "sender": "customer",
      "user_id": 1,
      "content": "{\"type\":\"message\",\"data\":{\"content\":\"有新的咨询进来了。\"},\"im_sub_session_id\":1}",
      "session_id": 1,
      "sub_session_id": 1,
      "survey_option_id": null
    }
  ],
  "size": 1,
  "total": 1,
  "total_pages": 1
}

获取满意度调查结果

该接口用于一次获取多个指定时段的满意度调查结果 频率限制 1 次/2 秒

请求方法

GET /api/v2/im/vote

请求参数(Query String)

参数名 必填 说明
start_time 记录开始时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 0 点
end_time 记录结束时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 24 点
page 页码,从 1 开始,默认为 1
page_size 每页数量,默认 30,最大 1000

start_time 和 end_time 查询的是满意度调查结果的创建时间; start_time 和 end_time 的格式为:“YYYY-MM-DD hh:mm:ss”,也可省略时间部分:“YYYY-MM-DD”。

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
size 整型 本次返回的数据数量
total 整型 数据总数
total_pages 整型 总页数
item 数组 满意度调查结果列表,每个元素的内容参见下文

满意度调查结果

属性名 类型 说明
id 整型 唯一标识
created_at 日期时间 创建时间
session_id 整型 所属会话 id
sub_session_id 整型 所属子会话 id
survey_option_id 整型 选择的选项 id

示例

curl https://demo.udesk.cn/api/v2/im/vote?page=1&page_size=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
  "status": 0,
  "message": "成功",
  "item": [
    {
      "id": 1,
      "created_at": "2015-01-01 12:00:00",
      "session_id": 1,
      "sub_session_id": 1,
      "survey_option_id": 1
    }
  ],
  "size": 1,
  "total": 1,
  "total_pages": 1
}

获取业务记录

该接口用于一次获取多个指定时段的 IM 业务记录信息 频率限制 1 次/2 秒

请求方法

GET /api/v2/im/note

请求参数(Query String)

参数名 必填 说明
start_time 记录开始时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 0 点
end_time 记录结束时间:传值时若没有时分秒,则默认时分秒是0时0分0秒。未传值时默认为查询当天 24 点
page 页码,从 1 开始,默认为 1
page_size 每页数量,默认 30,最大 1000

start_time 和 end_time 查询的是业务记录的创建时间; start_time 和 end_time 的格式为:“YYYY-MM-DD hh:mm:ss”,也可省略时间部分:“YYYY-MM-DD”。

返回数据

属性名 类型 说明
status 整型 执行结果码,0 代表成功
message 字符串 执行结果说明
size 整型 本次返回的数据数量
total 整型 数据总数
total_pages 整型 总页数
item 数组 业务记录列表,每个元素的内容参见下文

业务记录

属性名 类型 说明
id 整型 唯一标识
created_at 日期时间 创建时间
note_type 字符串 业务记录类型,一般为"im"
session_id 整型 所属会话 id
sub_session_id 整型 所属子会话 id
content 字符串 内容
custom_fields 数组 自定义字段,详见下文

custom_fields

custom_fields 是一个数组,并且它的每一个元素也是一个包含两个元素的数组,第一个元素为自定义字段的标识名,第二个元素为该字段在此业务记录中的值。

[["标识名", "值"]]

业务记录使用的自定义字段的标识名与工单自定义字段是一致的。

详见示例。

示例

curl https://demo.udesk.cn/api/v2/im/note?page=1&page_size=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
  "status": 0,
  "message": "成功",
  "item": [
    {
      "id": 1,
      "created_at": "2015-01-01 12:00:00",
      "note_type": "im",
      "session_id": 1,
      "sub_session_id": 1,
      "content": null,
      "custom_fields": [
        ["TextField_1", "普通文本内容"], // 普通文本
        ["TextField_2", "多行文本内容1\r\n多行文本内容2"], // 多行文本
        ["TextField_3", "2016-08-11"], // 日期
        ["TextField_4", "14:44:36"], // 时间
        ["TextField_5", "2017-05-03 14:44"], // 日期时间
        ["TextField_6", "https://www.sample.com"], // 链接
        ["TextField_7", "13"], // 正整数
        ["TextField_8", "13.33"], // 数值
        ["SelectField_1", "0"], // 下拉列表,下拉选项1
        ["SelectField_2", "0"], // 单选框,单选框选项1
        ["SelectField_3", "0,3"] // 多选框,多选框选项1、多选框选项4
      ]
    }
  ],
  "size": 1,
  "total": 1,
  "total_pages": 1
}

发送 IM 结构化消息

该接口用于通过 IM 向客户发送结构化消息 频率限制 1 次/2 秒

鉴权

签名方法,参看鉴权方法,但是需要注意以下两点:

请求方法

POST /api/v2/im/struct/messages

请求参数(Query String)

参数名 必填 说明
im_sub_session_id 会话 id
customer_id 客户 id
agent_id 客服 id
timestamp 时间戳

注:通过API创建的客户不能用于这个接口

请求参数(Request Body)

参数名 必填 类型 说明
jid_resource 字符串 SDK 渠道来源
data 对象 结构话消息

data

参数名 必填 类型 说明
title 字符串 标题
description 字符串 描述
img_url 字符串 显示图片的链接
buttons 数组 按钮列表

buttons 元素的结构

参数名 必填 类型 说明
type 字符串 按钮类型
text 字符串 按钮标题
value 字符串 按钮值
callback_name 字符串 回调名称,仅在 type 为 sdk_callback 时有效

type 的取值范围

取值 含义
link 链接按钮
phone 电话按钮
sdk_callback 回调按钮(仅 SDK 支持)

返回数据

属性名 类型 说明
status 整型 执行结果码,1000 代表成功
message 字符串 执行结果说明

示例

curl https://demo.udesk.cn/api/v2/im/struct/messages?im_sub_session_id=1&customer_id=1&agent_id=1&timestamp=1494814031&sign=129da7df812jdfsa9912jfdadf81 \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "data": {
        "title": "测试API发送结构化消息",
        "description": "该消息来自API",
        "img_url": "https://www.udesk.cn/images/index/banner01.jpg",
        "buttons": [
            {
                "type": "link",
                "text": "访问",
                "value": "https://www.udesk.cn"
            },
            {
                "type": "phone",
                "text": "拨打电话",
                "value": "010-12345678"
            },
            {
                "type": "sdk_callback",
                "callback_name": "sdk_callback",
                "text": "回调按钮",
                "value": "v1"
            }
        ]
    }
}'

返回

{
  "status": 1000,
  "message": "发送成功"
}

自定义 IM 结构化消息列表页面

自定义 IM 结构化消息列表页面,是一个由 ️ 您提供的 HTML 页面,其中包含了常用的结构化消息,以便于客服在 Udesk IM 操作台快速选择并发送给客户。

要使用自定义 IM 结构化消息列表页面,需要以下两步:

  1. 首先需要您编写一个 HTMl 页面,并提供该页面的公网地址;
  2. 在 Udesk 【管理中心】-【结构化消息】中设置好“嵌入链接”。

编写 HTMl 页面

Udesk 会在客服需要选择结构化消息时,将您提供的 HTML 页面以 iframe 的方式展现给客服,并将以下参数以 Query String 的方式传递给您的 HTML 页面:

参数名 说明
im_sub_session_id 会话 id
customer_id 客户 id
agent_id 客服 id
jid_resource SDK 来源
timestamp 时间戳

此外,按照鉴权方法计算出的签名,也会作为 sign 参数一起传递。

计算签名时,与鉴权方法稍有不同,与发送 IM 结构化消息接口一致。 您在收到请求后,最好先校验 sign 值是否合法,再决定是否返回 HTML 页面。

同时,在 HTML 页面中,您可以用以上参数调用发送 IM 结构化消息接口,以完成结构化消息的发送。

设置

  1. 使用管理员登录 Udesk 系统;
  2. 打开【管理中心】-【渠道管理】-【即时通讯】-【结构化消息】;
  3. 将“嵌入链接”设置为您提供的 HTML 页面的公网地址。

示例

假设在【管理中心】中的设置如下:

当客服在 IM 工作台聊天界面点击“结构化消息”列表图标时,Udesk 会展示包含类似以下地址的 iframe 页面:

https://www.demo.com/struct_message?im_sub_session_id=1&customer_id=1&agent_id=1&jid_resource=12dsafdaslj129das-12fds912-12dsa&timestamp=1484272693&sign=4666293b3dfe91aa97179dc701be7afc

注意,其中的 sign 的计算方法为:

md5("im_sub_session_id=1&customer_id=1&agent_id=1&timestamp=1484272693&708ff6dc-41d5-4med-9ebc-0388zz9d76f1")
#=> 4666293b3dfe91aa97179dc701be7afc

数据结构-IM

IM 对话记录

属性名 类型 说明
sub_session_id 整型 id (同 im_sub_session_id)
session_id 整型 会话 id
note_id 整型 业务记录 id
customer_id 整型 客户 id
customer_name 字符串 客户姓名
customer_custom_fields 对象 客户自定义字段,详见下文
agent_id 整型 客服 id
agent_nick_name 字符串 客服姓名
resp_seconds 整型 响应时间,单位秒
queue_seconds 字符串 排队时间,单位秒
sustain_seconds 整型 持续时间
survey_vote_id 整型 满意度调查结果 id
platform 字符串 渠道,取值:web、微信、微博、android、ios、api
web_info 对象 浏览器访问信息,详见下文
weixin_info 对象 微信访问信息,详见下文
weibo_info 对象 微博访问信息,详见下文
api_info 对象 API 访问信息
ios_info 对象 iOS SDK 访问信息
android_info 对象 Android SDK 访问信息
created_at 日期时间 创建时间
closed_at 日期时间 关闭时间
belong_queue 字符串 排队队列
agent_msg_num 整型 客服消息数
customer_msg_num 整型 客户消息数
source 字符串 来源
source_url 字符串 来源 url
queue_start_time 日期时间 排队开始时间
conversations_num_today 整型 当日对话次数
search_keyword 字符串 搜索关键词
custom_channel 字符串 自定义渠道信息
agent_invite_vote_count 整型 客服邀评次数
last_response 字符串 最后消息发送方 取值: customer、agent、blank
alert_num 整型 报警次数
alert_desc 字符串 报警项
ticket_num 整型 工单数量
ticket_nos 字符串 工单编号,已逗号","分割
im_web_plugin_id 整型 来源插件 ID
sender 字符串 对话发起方 取值:"customer、agent、sys" 说明:"客户、客服、系统"
active_guest 字符串 访客邀请 取值:"agent、sys、blank" 说明:"客服、自动、无"
ticket_ids 数组 此对话记录对应的工单
organization_id 整型 公司id
menu_names 字符串 导航菜单名称

客户浏览器访问信息

属性名 类型 说明
login_url 字符串
session_url 字符串
keyword 字符串
src 字符串
src_url 字符串 同source_url
sys 字符串
bowser 字符串
generated_channel 字符串
ip 字符串

微信访问信息

属性名 类型 说明
name 字符串 客户微信昵称

微博访问信息

属性名 类型 说明
name 字符串 客户微博昵称

API 访问信息

属性名 类型 说明
from 字符串 固定为"API"

iOS SDK 访问信息

属性名 类型 说明
phone_modal 字符串
phone_version 字符串
app_name 字符串
network_status 字符串
carrier 字符串
scale_screen 字符串

Android SDK 访问信息

属性名 类型 说明
phone_modal 字符串
phone_version 字符串
app_name 字符串
network_status 字符串
carrier 字符串
scale_screen 字符串

IM 聊天记录

属性名 类型 说明
id 整型 唯一标识
created_at 日期时间 创建日期
sender 字符串 发送人身份,agent 或 customer
user_id 整型 发送人 id
content 字符串 消息内容
session_id 整型 所属会话 id
sub_session_id 整型 所属子会话 id
survey_option_id 整型 满意度调查结果 id

status错误码说明

错误码 message信息 描述
2000 暂只提供30天内的数据 只有参数{start_time}或{end_time}时,日期距今30天以上
对不起,该资源不存在 未找到数据,请求参数错误
NoMethodError 必填参数未填写
暂只提供90天内的数据 参数{start_time}或{end_time}距今90天以上
无会话记录 必填参数{session_id}错误,未查到会话数据
session_id 不能为空 必填参数{session_id}未填写或为空
ActiveRecord::StatementInvalid 参数{page_size}或{page}不在取值范围内
2002 签名错,请升级版本后使用! 参数{sign}错误,鉴权未通过
9010 消息发送失败 客户端版本不支持 此客户为api渠道创建的客户,不能通过接口发送IM结构化消息