目录

通话记录

JSON格式

名称 类型 注释
callid varchar 通话记录id，系统自动分配
direction tinyint 呼叫方向：0-呼入，1-呼出，2-座席内呼
appraisetinyint 评价：1-非常满意，2-满意，3-不满意
fromPhone varchar主叫号码
toPhone varchar被叫号码，座席内呼时，该值为客服id
Transfer tinyint是否转接：0-未转接，1-转接
TransferTimedatetime转接时间，格式为：2017-8-28 14:24:12
TransferToAgentid int转接到的客服id
agentidint处理客服id
digitssmallint用户按键内容
fromattrvarchar号码归属地
CallSummarytext通话总结
alertingTimedatetime振铃时间，格式为：2017-08-27
starttimedatetime主叫开始时间，格式为：2017-08-27
endtimedatetime主叫结束时间，格式为：2017-08-27
sstimedatetime被叫开始时间，格式为：2017-08-27
setimedatetime被叫结束时间，格式为：2017-08-27
eventFlowStatetinyint流程状态码 1-IVR放弃 2-IVR自动挂断 3-无可用座席 4-排队放弃 5-话机离线 7-已接听 6/8-振铃未接听 9-座席拒接 10-语音留言 11-客户速挂
calldurationint主叫通话时长，单位：秒
seccalldurationint被叫通话时长，单位：秒
recordurlvarchar录音文件下载地址

JSON示例

{
    "callid": 123,
    "direction": 0,
    "appraise": 1,
    "fromPhone": "13240138421",
    "toPhone": "18582082009",
    "Transfer": 0,
    "TransferTime": "2017-8-27 10:20:12",
    "TransferToAgentid": 243,
    "agentid": 132,
    "digits": 2,
    "fromattr": "北京市",
    "CallSummary": "这里是本次通话的一些总结",
    "alertingTime": "2017-08-27 10:20:12",
    "starttime": "2017-08-27 10:21:10",
    "endtime": "2017-08-27 10:22:40",
    "sstime": "2017-08-27 10:21:15",
    "setime": "2017-08-27 10:22:35",
    "eventFlowState": "6",
    "callduration": 90,
    "seccallduration":80,
    "recordurl": "http://ccp02.oss.aliyuncs.com/ivr_record/4001222344/20170818/R0032de32_20170818185454.wav"
}

通话记录列表

GET /api/v1/callrecord/histories.json

调用者权限 

管理员

调用参数

名称 必需的 类型 注释
starttime 否 datetime 按创建时间筛选，开始时间，格式为：2017-08-27
endtime 否 datetime 按创建时间筛选，结束时间，格式为：2017-08-29
page 否 int 分页获取，默认为1
per_page 否 int 每页大小，默认为100

说明：
1、结束时间是包含当前时间的，例如结束时间为2017-08-29，则返回的记录包含2017-08-29当天的。
2、一个callid唯一标识一条通话记录，当一次通话被转接过，则返回数据会有多条callid一样的记录。

调用示例 

curl https://www.bangwo8.com/api/v1/callrecord/histories.json \
  -v -u {account}:{password}

返回值示例 

Status: 200 OK

{
  "callrecords": [
    {
      "callid": 123,
      "direction": 0,
      ...
    },
    {
      "callid": 124,
      "direction": 1,
      ...
    },
    ...
  ],
  "count": 42,
  "next_page": "https://www.bangwo8.com/api/v1/callrecord/histories.json?per_page=40&page=2",
  "previous_page": null
}

查看指定手机号的通话记录列表

GET /api/v1/callrecord/histories.json

调用者权限 

所有客服

调用参数

名称 必需的 类型 注释
starttime 否 datetime 按创建时间筛选，开始时间，格式为：2021-10-27
endtime 否 datetime 按创建时间筛选，结束时间，格式为：2021-10-29
page 否 int 分页获取，默认为1
per_page 否 int 每页大小，默认为100
fromPhone 是 varchar 客户号码
direction 否 tinyint 呼叫方向：0-呼入，1-呼出，2-座席内呼

说明：
1、结束时间是包含当前时间的，例如结束时间为2017-08-29，则返回的记录包含2017-08-29当天的。
2、一个callid唯一标识一条通话记录，当一次通话被转接过，则返回数据会有多条callid一样的记录。 调用示例 

curl https://www.bangwo8.com/api/v1/callrecord/histories.json?fromPhone=18811782893&starttime=2021-10-01 \
  -v -u {account}:{password}

返回值示例 

{
    "callrecords": [
        {
            "crId": "41437678",
            "callid": "1444482746163488521763",
            "direction": "1",
            "appraise": "0",
            "fromPhone": "18811782893",
            "toPhone": "",
           ...
        },
        {
            "crId": "41439103",
            "callid": "1444482746163488591114",
            "direction": "1",
            "appraise": "0",
            "fromPhone": "18811782893",
            "toPhone": "",
           ...
        },
        {
            "crId": "41439127",
            "callid": "1444482746163488592530",
            "direction": "1",
            "appraise": "0",
            "fromPhone": "18811782893",
            "toPhone": "",
           ...
        }
    ],
    "count": "3",
    "previous_page": "",
    "next_page": ""
}

查看指定客服的通话记录列表

GET /api/v1/callrecord/supporthistories/{id}.json

调用者权限 

管理员

调用参数

名称 必需的 类型 注释
starttime 否 datetime 按创建时间筛选，开始时间，格式为：2017-08-27
endtime 否 datetime 按创建时间筛选，结束时间，格式为：2017-08-29
page 否 int 分页获取，默认为1
per_page 否 int 每页大小，默认为100

说明：
1、结束时间是包含当前时间的，例如结束时间为2017-08-29，则返回的记录包含2017-08-29当天的。
2、一个callid唯一标识一条通话记录，当一次通话被转接过，则返回数据会有多条callid一样的记录。

调用示例 

curl https://www.bangwo8.com/api/v1/callrecord/supporthistories/{id}.json \
  -v -u {account}:{password}

返回值示例 

Status: 200 OK

{
  "callrecords": [
    {
      "callid": 123,
      "direction": 0,
      ...
    },
    {
      "callid": 124,
      "direction": 1,
      ...
    },
    ...
  ],
  "count": 42,
  "next_page": "https://www.bangwo8.com/api/v1/callrecord/supporthistories/{id}.json?per_page=40&page=2",
  "previous_page": null
}

查看指定通话记录

GET /api/v1/callrecord/histories/{id}.json

调用者权限 

所有客服

调用示例 

curl https://www.bangwo8.com/api/v1/callrecord/histories/1601221206243740000100750000c343.json -v -u {account}:{password}

返回值示例 

Status: 200 OK

{
	"callrecord": {
	    "callid": "1601221206243740000100750000c343",
            "direction": "0",
            "appraise": "0",
            "fromPhone": "15200323154",
            "toPhone": "",
            "Transfer": "0",
            "TransferTime": "0000-00-00 00:00:00",
            "TransferToAgentid": "0",
            "agentid": "0",
            "digits": "0",
            "fromattr": "湖南长沙",
            "CallSummary": null,
            "alertingTime": "0000-00-00 00:00:00",
            "starttime": "2016-01-22 11:55:59",
            "endtime": null,
            "sstime": null,
            "setime": null,
            "callduration": "0",
            "seccallduration": "0",
            "recordurl": "http://ccp02.oss.aliyuncs.com/ivr_record/4001222344/20170818/R0032de32_20170818185454.wav",
	}
}

查看指定通话的服务总结

请求参数

名称 必填 类型 注释
callid是 int通话id
servicesummary_type是 int 1-im 2-呼叫中心 3-远程协助 获取呼叫中心的通话服务总结servicesummary_type=2

请求地址 

GET  /api/v1/servicesummary/{callid}.json

调用者权限 

所有客服

调用示例 

curl https://www.bangwo8.com/api/v1/servicesummary/221.json -v -u {account}:{password}

返回参数

名称 只读 类型 注释
ticketTemplateName是 String模板名称
custom_fields是 array 服务总结模板自定义字段

返回值示例 

{
    "status":"200" ,
    "message":"Successful",
    "data":{
      "serviceSummary":{
         "ticketTemplateName": "服务总结模板名称"，
          "custom_fields": [//自定义字段
          {
              "key": "field_1",//自定义字段的唯一标识，可从帮我吧后台查看
              "value": "4334"
          },
          {
              "key": "field_3",//自定义字段的唯一标识，可从帮我吧后台查看
              "value": "1" //复选框
          },
          {
              "key": "field_2",
              "value": "下拉菜单的某一项"
          },
          {
              "key": "field_4",
              "value": "附件的下载地址" //附件多个时，以逗号分隔
          }
         ]
    
        }  
    }
}

//注意 
没有绑定服务总结模板返回示例
 { "status":"120001" ,
   "message":"No service summary template",
}
未填写服务总结返回示例
 { "status":"120002" ,
   "message":"No service summary information",
}

录音解冻接口

录音时间超过两个月，录音会进入冷冻状态，即：获取录音之前需要先解冻后方能使用，解冻时效为24小时，超过24小时仍需要再次解冻。解冻大概需要2分钟解冻成功，解冻成功后可直接访问原来的录音地址。

请求参数

名称 必填 类型 注释
url是 varchar录音地址，可以通过获取通话记录详情接口获取到该地址
restore是 int 固定值写1

请求地址 

GET  /api/v1/recordVoiceRestore.json?url=xxx&restore=1

调用者权限 

所有客服

调用示例 

curl https://www.bangwo8.com/api/v1/recordVoiceRestore.json?url=xxx&restore=1 -v -u {account}:{password}

返回参数

名称 类型 注释
status String状态 RestoreAlreadyInProgress-解冻中，RestoreCompleted-解冻完成，OperationNotSupported-不支持解冻，NoSuchKey-目标不存在，RestoreFailed-解冻失败，RestoreTodo-解冻，ExceptionStatus-文件状态异常，请联系管理员
file_pathString录音文件地址，注意这里是相对地址
file_nameString录音文件名称

返回示例 

{
    "status": "CorrectStatus",
    "message": "状态正常",
    "file_path": "/recordings/71f717e43078338c/7a0604948a6b615c/20230101/xxx.wav",
    "file_name": "xxx.wav"
}