对话分析接口
通过API获取对话分析接口
- URL：
https://api.nxcloud.com/saas/openapi/stat/query?page_number={page_number}&page_size={page_size}&start_date={start_date}&end_date={end_date}&tenant_id={tenant_id}&appkey={appkey}&dimension={dimension}&user_name={user_name}&user_group_name={user_group_name}&type={type}&response_type={response_type}
- Method：
GET
- Content-Type：
application/json
- 需要鉴权：
是
请求参数
| 参数名 |
类型 |
必选 |
示例值 |
说明 |
| accessKey |
String |
是 |
fme2na3kdi3ki |
用户身份标识 |
| ts |
String |
是 |
1655710885431 |
当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒 |
| bizType |
String |
是 |
2 |
WhatsApp业务类型，取固定值“2” |
| action |
String |
是 |
mt |
WhatsApp业务操作，取固定值“mt” |
| sign |
String |
是 |
6e9506557d1f289501d333ee2c365826 |
API入参参数签名，公共约定 |
parameter 参数：
| 参数名 |
类型 |
必选 |
示例值 |
说明 |
| tenant_id |
Long |
是 |
1 |
租户ID |
| appkey |
String |
是 |
pem28kje |
应用appkey |
| page_number |
integer |
是 |
1 |
页数 |
| page_size |
integer |
是 |
10 |
每页个数 |
| start_date |
String |
是 |
开始查询日期 |
格式为yyyy-mm-dd |
| end_date |
String |
是 |
截止查询日期 |
格式为yyyy-mm-dd (时间查询范围不能超过6个月) |
| dimension |
integer |
是 |
统计维度 |
统计维度, 0: 客服, 1: 客服组, 2: 机器人，3: 国家 |
| type |
integer |
是 |
时间维度 |
时间维度 0:天，1:小时 |
| user_name |
String |
否 |
搜索用户名称 |
|
| user_group_name |
String |
否 |
搜索分组名称 |
|
| response_type |
integer |
否 |
响应类型 |
1:5分钟，2:1小时，3:12小时，4:24小时 (默认为1小时) |
| country_iso2 |
String |
否 |
国际域名缩写 |
当dimension为3时，搜索国家填写 |
返回参数说明
| 参数名 |
类型 |
说明 |
| list |
array[data JsonObject] |
请求结果 |
| message |
string |
请求结果说明 |
| code |
integer |
结果编码 |
| total |
integer |
列表总数量 |
| page_number |
integer |
页数 |
| page_size |
integer |
每页数量 |
data
| 参数名 |
类型 |
说明 |
| id |
Long |
对话分析id |
| user_id |
Long |
用户id |
| user_name |
String |
用户名称 |
| user_email |
String |
用户邮箱 |
| user_group_id |
Long |
分组id |
| user_group_name |
String |
分组名称 |
| created_at |
String |
模板创建时间 |
| conversation_count |
Long |
接入会话数 |
| conversation_end_count |
Long |
结束会话数 |
| message_count |
Long |
消息总数 |
| message_user_count |
Long |
客服消息数 |
| message_customer_count |
Long |
客户消息数 |
| single_conversation_max_count |
Long |
单会话消息数最大值 |
| single_conversation_avg_count |
Long |
单会话消息平均值 |
| conversation_max_duration |
Double |
会话时长最大值 |
| conversation_avg_duration |
Double |
会话时长平均值 |
| intera_count |
Long |
处理对话数 |
| first_response_count |
Long |
首次响应数量 |
| first_response_duration |
Double |
首次响应时长 |
| first_response_rate |
Double |
首次响应率 |
| response_count |
Long |
响应数量 |
| response_duration |
Long |
响应时长 |
| response_rate |
doDoubleble |
响应率 |
| country |
String |
国家 |
响应示例
{
"code": 0,
"message": null,
"traceId": "ee0e74276ff14dd58c43512c92ed9958.315.17223186559662193",
"total": 19,
"page_number": 1,
"page_size": 10,
"list": [
{
"id": 1310899,
"user_id": 123445,
"user_name": "",
"user_email": "",
"user_group_id": 0,
"user_group_name": "",
"created_at": "2024-07-26",
"conversation_count": 0,
"conversation_end_count": 1,
"message_count": 0,
"message_user_count": 0,
"message_customer_count": 0,
"single_conversation_max_count": 1,
"single_conversation_avg_count": 1,
"conversation_max_duration": 1216047.00,
"conversation_avg_duration": 1216047.00,
"conversation_first_response_avg_duration": 1216047.00,
"intera_count": 0,
"first_response_count": 0,
"first_response_duration": 0,
"first_response_rate": 0,
"response_count": 0,
"response_duration": 0,
"response_rate": 0,
"country": "CHINA"
}
],
"ext": null,
"empty": false,
"notEmpty": true,
"totalPages": 19
}
响应码说明
| code |
message |
解决办法 |
| 0 |
请求成功 |
|
| -1 |
请求失败 |
请联系技术人员排除问题 |
| 1000~100X |
鉴权问题 |
详情查看API鉴权部分 |
| 21058 |
参数异常 |
tenant_id 必填 |
| 21059 |
参数异常 |
appkey必填 |
| 22016 |
参数异常 |
商户未配置WhatsApp应用 |
| 22215 |
参数异常 |
查询日期间隔不能超过6个月 |
国际域名缩写说明
| iso2 |
国家/地区（中文） |
国家/地区（英文） |
| AD |
安道尔 |
ANDORRA |
| AE |
阿拉伯联合酋长国 |
UNITED ARAB EMIRATES |
| AF |
阿富汗 |
AFGHANISTAN |
| AG |
安提瓜和巴布达岛 |
ANTIGUA & BARBUDA |
| AI |
安圭拉 |
ANGUILLA |
| AL |
阿尔巴尼亚 |
ALBANIA |
| AM |
亚美尼亚 |
ARMENIA |
| AN |
荷属安的列斯群岛 |
NETHERLANDS ANTILLES |
| AO |
安哥拉 |
ANGOLA |
| AR |
阿根廷 |
ARGENTINA |
| AS |
美国萨摩亚 |
AMERICAN SAMOA |
| AT |
奥地利 |
AUSTRIA |
| AU |
澳大利亚 |
AUSTRALIA |
| AW |
阿鲁巴 |
ARUBA |
| AZ |
阿塞拜疆 |
AZERBAIJAN |
| BB |
巴巴多斯 |
BARBADOS |
| BD |
孟加拉国 |
BANGLADESH |
| BE |
比利时 |
BELGIUM |
| BF |
布基纳法索 |
BURKINA FASO |
| BG |
保加利亚 |
BULGARIA |
| BH |
巴林 |
BAHRAIN |
| BI |
布隆迪 |
BURUNDI |
| BJ |
贝宁 |
BENIN |
| BM |
百慕大群岛 |
BERMUDA |
| BO |
玻利维亚 |
BOLIVIA |
| BR |
巴西 |
BRAZIL |
| BS |
巴哈马 |
BAHAMAS |
| BT |
不丹 |
BHUTAN |
| BW |
博茨瓦纳 |
BOTSWANA |
| BY |
白俄罗斯 |
BELARUS |
| BZ |
伯利兹 |
BELIZE |
| CA |
加拿大 |
CANADA |
| CF |
中非共和国 |
CENTRAL AFRICAN REPUBLIC |
| CG |
刚果 |
CONGO |
| CH |
瑞士 |
SWITZERLAND |
| CI |
科特迪瓦 |
COTE DIVOIRE |
| CK |
库克群岛 |
COOK ISLANDS |
| CL |
智利 |
CHILE |
| CM |
喀麦隆 |
CAMEROON |
| CN |
中国 |
CHINA |
| CO |
哥伦比亚 |
COLOMBIA |
| CR |
哥斯达黎加 |
COSTA RICA |
| CU |
古巴 |
CUBA |
| CV |
佛得角 |
CAPE VERDE |
| CW |
库拉索 |
Curaçao |
| CY |
塞浦路斯 |
CYPRUS |
| CZ |
捷克共和国 |
CZECH REPUBLIC |
| DE |
德国 |
GERMANY |
| DG |
迭戈加西亚 |
DIEGO GARCIA |
| DJ |
吉布提 |
DJIBOUTI |
| DK |
丹麦 |
DENMARK |
| DM |
多米尼克 |
DOMINICA |
| DO |
多明尼加共和国 |
DOMINICAN REPUBLIC |
| DZ |
阿尔及利亚 |
ALGERIA |
| EC |
厄瓜多尔 |
ECUADOR |
| EE |
爱沙尼亚 |
ESTONIA |
| EG |
埃及 |
EGYPT |
| ER |
厄立特里亚 |
ERITREA |
| ES |
西班牙 |
SPAIN |
| ET |
埃塞俄比亚 |
Ethiopia |
| FI |
芬兰 |
FINLAND |
| FJ |
斐济 |
FIJI |
| FK |
福克兰群岛 |
FALKLAND ISLANDS |
| FM |
密克罗尼西亚联邦 |
Micronesia |
| FO |
法罗群岛 |
FAROE ISLANDS |
| FR |
法国 |
FRANCE |
| GA |
加蓬 |
GABON |
| GB |
英国 |
UNITED KINGDOM |
| GD |
格林纳达 |
GRENADA |
| GE |
格鲁吉亚 |
GEORGIA |
| GF |
法属圭亚那 |
FRENCH GUIANA |
| GH |
加纳 |
GHANA |
| GI |
直布罗陀 |
GIBRALTAR |
| GL |
格陵兰岛 |
GREENLAND |
| GM |
冈比亚 |
GAMBIA |
| GN |
几内亚 |
GUINEA |
| GP |
瓜德罗普岛 |
GUADELOUPE |
| GQ |
赤道几内亚 |
EQUATORIAL GUINEA |
| GR |
希腊 |
GREECE |
| GT |
危地马拉 |
GUATEMALA |
| GU |
关岛 |
GUAM |
| GW |
几内亚比绍 |
GUINEA-BISSAU |
| GY |
圭亚那 |
GUYANA |
| HK |
中国香港 |
HONG KONG |
| HN |
洪都拉斯 |
HONDURAS |
| HR |
克罗地亚 |
CROATIA |
| HT |
海地 |
HAITI |
| HU |
匈牙利 |
HUNGARY |
| ID |
印度尼西亚 |
INDONESIA |
| IE |
爱尔兰 |
IRELAND |
| IL |
以色列 |
ISRAEL |
| IN |
印度 |
INDIA |
| IQ |
伊拉克 |
IRAQ |
| IR |
伊朗 |
IRAN |
| IS |
冰岛 |
ICELAND |
| IT |
意大利 |
ITALY |
| JM |
牙买加 |
JAMAICA |
| JO |
约旦 |
JORDAN |
| JP |
日本 |
JAPAN |
| KE |
肯尼亚 |
KENYA |
| KG |
吉尔吉斯斯坦 |
KYRGYZSTAN |
| KH |
柬埔寨 |
CAMBODIA |
| KI |
基里巴斯 |
Kiribati |
| KM |
科摩罗 |
COMOROS |
| KP |
朝鲜 |
North Korea |
| KR |
韩国 |
SOUTH KOREA |
| KW |
科威特 |
KUWAIT |
| KY |
开曼群岛 |
CAYMAN ISLANDS |
| KZ |
哈萨克斯坦 |
Kazakhstan |
| LA |
老挝 |
LAOS |
| LB |
黎巴嫩 |
LEBANON |
| LI |
列支敦士登 |
LIECHTENSTEIN |
| LK |
斯里兰卡 |
SRI LANKA |
| LR |
利比里亚 |
LIBERIA |
| LS |
莱索托 |
LESOTHO |
| LT |
立陶宛 |
LITHUANIA |
| LU |
卢森堡 |
LUXEMBOURG |
| LV |
拉脱维亚 |
LATVIA |
| LY |
利比亚 |
LIBYA |
| MA |
摩洛哥 |
MOROCCO |
| MC |
摩纳哥 |
MONACO |
| MD |
摩尔多瓦 |
MOLDOVA |
| ME |
黑山 |
MONTENEGRO |
| MG |
马达加斯加 |
MADAGASCAR |
| MH |
马绍尔群岛共和国 |
Marshall Islands |
| MK |
北马其顿 |
North Macedonia |
| ML |
马里 |
MALI |
| MM |
缅甸 |
MYANMAR |
| MN |
蒙古 |
MONGOLIA |
| MO |
中国澳门 |
MACAU |
| MP |
北马里亚纳群岛 |
NORTHERN MARIANA ISLANDS |
| MQ |
马提尼克 |
MARTINIQUE |
| MR |
毛里塔尼亚 |
MAURITANIA |
| MS |
蒙特塞拉特岛 |
MONTSERRAT |
| MT |
马耳他 |
MALTA |
| MU |
毛里求斯 |
MAURITIUS |
| MV |
马尔代夫 |
MALDIVES |
| MW |
马拉维 |
MALAWI |
| MX |
墨西哥 |
MEXICO |
| MY |
马来西亚 |
MALAYSIA |
| MZ |
莫桑比克 |
MOZAMBIQUE |
| NA |
纳米比亚 |
NAMIBIA |
| NC |
新喀里多尼亚 |
NEW CALEDONIA |
| NE |
尼日尔 |
NIGER |
| NF |
诺福克岛 |
NORFOLK ISLAND |
| NG |
尼日利亚 |
NIGERIA |
| NI |
尼加拉瓜 |
NICARAGUA |
| NL |
荷兰 |
NETHERLANDS |
| NO |
挪威 |
NORWAY |
| NP |
尼泊尔 |
NEPAL |
| NR |
瑙鲁 |
NAURU |
| NU |
纽埃 |
Niue |
| NZ |
新西兰 |
NEW ZEALAND |
| OM |
阿曼 |
OMAN |
| PA |
巴拿马 |
PANAMA |
| PE |
秘鲁 |
PERU |
| PF |
法属波利尼西亚 |
FRENCH POLYNESIA |
| PG |
巴布亚新几内亚 |
PAPUA NEW GUINEA |
| PH |
菲律宾 |
PHILIPPINES |
| PK |
巴基斯坦 |
PAKISTAN |
| PL |
波兰 |
POLAND |
| PR |
波多黎各 |
Puerto Rico |
| PT |
葡萄牙 |
PORTUGAL |
| PW |
帕劳 |
PALAU |
| PY |
巴拉圭 |
PARAGUAY |
| QA |
卡塔尔 |
QATAR |
| RE |
留尼汪 |
REUNION |
| RO |
罗马尼亚 |
ROMANIA |
| RS |
塞尔维亚 |
SERBIA |
| RU |
俄罗斯 |
RUSSIA |
| RW |
卢旺达 |
RWANDA |
| SA |
沙特阿拉伯 |
SAUDI ARABIA |
| SB |
所罗门群岛 |
Solomon Islands |
| SC |
塞舌尔 |
SEYCHELLES |
| SD |
苏丹 |
SUDAN |
| SE |
瑞典 |
SWEDEN |
| SG |
新加坡 |
SINGAPORE |
| SH |
圣赫勒拿岛 |
St. Helena |
| SI |
斯洛文尼亚 |
SLOVENIA |
| SK |
斯洛伐克 |
SLOVAKIA |
| SL |
塞拉利昂 |
SIERRA LEONE |
| SM |
圣马力诺 |
SAN MARINO |
| SN |
塞内加尔 |
SENEGAL |
| SO |
索马里 |
SOMALIA |
| SR |
苏里南 |
SURINAME |
| SS |
南苏丹 |
SOUTH SUDAN |
| ST |
圣多美和普林西比 |
SAO TOME & PRINCIPE |
| SV |
萨尔瓦多 |
EL SALVADOR |
| SY |
叙利亚 |
SYRIA |
| SZ |
斯威士兰 |
Swaziland |
| TC |
特克斯和凯科斯群岛 |
TURKS & CAICOS ISLANDS |
| TD |
乍得 |
CHAD |
| TG |
多哥 |
TOGO |
| TH |
泰国 |
THAILAND |
| TJ |
塔吉克斯坦 |
TAJIKISTAN |
| TL |
东帝汶 |
TIMOR-LESTE |
| TM |
土库曼斯坦 |
TURKMENISTAN |
| TN |
突尼斯 |
TUNISIA |
| TO |
汤加 |
TONGA |
| TR |
土耳其 |
TURKEY |
| TT |
特立尼达和多巴哥 |
TRINIDAD & TOBAGO |
| TV |
图瓦卢 |
Tuvalu |
| TW |
中国台湾 |
TAIWAN |
| TZ |
坦桑尼亚 |
TANZANIA |
| UA |
乌克兰 |
UKRAINE |
| UG |
乌干达 |
UGANDA |
| US |
美国 |
UNITED STATES |
| UY |
乌拉圭 |
URUGUAY |
| UZ |
乌兹别克斯坦 |
UZBEKISTAN |
| VA |
梵蒂冈城 |
Vatican City |
| VE |
委内瑞拉 |
VENEZUELA |
| VN |
越南 |
VIETNAM |
| VU |
瓦努阿图 |
VANUATU |
| WS |
萨摩亚 |
SAMOA |
| YE |
也门 |
YEMEN |
| YT |
马约特岛 |
Mayotte |
| ZA |
南非 |
SOUTH AFRICA |
| ZM |
赞比亚 |
ZAMBIA |
| ZW |
津巴布韦 |
ZIMBABWE |
