查询话单

1.1 版本说明

日期	版本	修订内容摘要
2023-10-10	v1.0.0	更新接口文档

1.2 协议说明

名称	说明
接口名称	查询话单
URL	https://api.253.com/data/api/voiceMsg/queryVoiceRecord
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

1.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大100）
mobile	String	否	被叫号码
messageType	String	是	查询的话单类型 1 语音验证码 2 国内语音消息 8 视频外呼
templateId	String	否	模板id
taskId	String	否	任务id（批量接口查询使用批量API接口返回的callid）
batchNo	String	否	批次号（单条接口查询使用单条API接口返回的callid）
startDate	String	是	开始调用时间（yyyy-MM-dd HH:mm:ss）(支持查最近90天)
endDate	String	否	结束调用时间（yyyy-MM-dd HH:mm:ss）

1.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>total	int	查询总数
data>>pageSize	int	每页个数
data>>pageNum	int	页码
data>>list	List	话单数据
data>>list>>callId	string	回调的callid
data>>list>>callDesc	string	错误码
data>>list>>callDescMsg	string	错误描述
data>>list>>mobile	string	被叫号码
data>>list>>templateId	string	模板id
data>>list>>callState	string	呼叫状态 0成功 1失败 2未知（空值表示本次通话在进行中
data>>list>>smsStatus	string	挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>smsSendTime	string	挂机短信发送时间 13位时间戳
data>>list>>fmsStatus	string	闪信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>recallCount	string	当前号码第几次呼叫，1：第一次呼叫，2：第二次呼叫
data>>list>>hangupCause	String	线路挂断原因

1.5 返回数据示例（成功）

{
  "message": "请求成功",
  "data": {
    "total": 12,
    "pageSize": 10,
    "list": [
      {
        "callId": "YYTZ1128********79040",
        "callDesc": "0",
        "mobile": "159*****82",
        "templateId": "11134*****042240",
        "callState": "1",
        "recallCount": "0",
        "callDescMsg": "未规定",
        "smsStatus": "0",
        "invokeTime": "1",
        "fmsStatus": "1",
        "fmsSendStatus": "DELIVRD",
        "hangupCause": "NORMAL_TEMPORARY_FAILURE/recv_refuse"
      },
      {
        "callId": "YYTZ1128********63553",
        "callDesc": "0",
        "mobile": "159*****182",
        "templateId": "1113********40",
        "callState": "1",
        "recallCount": "0",
        "callDescMsg": "未规定",
        "smsStatus": "0",
        "invokeTime": "1689****0877",
        "fmsStatus": "0",
        "fmsSendStatus": "",
        "hangupCause": "NORMAL_TEMPORARY_FAILURE/recv_refuse"
      }
    ],
    "pageNum": 2
  },
  "code": "200000"
}

产品中心

热门搜索

中国站

国际站

查询话单

查询话单