API文档

# 上传语音文件

# 接口说明

项 值
URL /v1/call/template/upload.json
描述 上传语音文件
请求方式 POST
需要登录 是
注意事项 表单
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
file file 语音文件 支持.mp3和.wav格式

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": "https://xxxxxx" // 语音文件地址
}

# 新增语音模板

# 接口说明

项 值
URL /v1/call/template/add.json
描述 新增语音模板
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
name string 模板名称 是
fileName string 语音文件名称 否
type number 模板类型 1：文本 2：语音 是
content string 对应内容 是

# 请求数据

{
    "name": "模板名称",
    "fileName":"xxx.mp3",//模板类型为 语音 时，语音文件名
    "type":1,	//模板类型 1：文本 2：语音
    "content": "内容" // 模板类型为2时，传入语音文件地址。
}

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": {
      "TplId": "Nauh6sn" // 模板ID
    }
}

# 自定义文本模板创建规则

  • 文本支持多个变量。
  • 变量请使用大括号格式，如{name}。
  • 语音模板内容仅支持 中英文、数字、基本符号（不支持\n \b等转义字符，不能含有【】符号）。
  • 模板示范：您的验证码为{number}，5分钟内有效！其中{数字}为可自定义的变量。

# 语音模板详情

# 接口说明

项 值
URL /v1/call/template/detail.json
描述 语音模板详情
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 模板id 是

# 请求数据

{
    "id": "Onxj62b"
}

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": {
    	"id":"Onxj62b",
    	"name":"模板名称",
    	"type":1, // 模板类型 1：文本 2：语音
    	"content":"模板内容",
    	"fileName":"voice.wav",// 语音文件名称
    	"createTime":1646286831382,
    	"updateTime":1646286831482
    }
}

# 编辑语音模板

# 接口说明

项 值
URL /v1/call/template/edit.json
描述 编辑语音模板
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 模板id 是
name string 模板名称 是
fileName string 语音文件名称 否
type number 模板类型 1：文本 2：语音 是
content string 对应内容 是

# 请求数据

{
    "id":"Onxj62b",
    "name": "模板名称",
    "fileName":"xxx.mp3",//模板类型为 语音 时，语音文件名
    "type":1,	//模板类型 1：文本 2：语音
    "content": "内容"
}

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": null
}

# 删除语音模板

# 接口说明

项 值
URL /v1/call/template/del.json
描述 删除语音模板
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 模板id 是

# 请求数据

{
    "id": "Onxj62b"
}

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": null
}

# 语音模板列表

# 接口说明

项 值
URL /v1/call/template/list.json
描述 语音模板列表
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string ID 否，与name二选一
name string 模板名称 否，与id二选一
type number 模板类型 否
pageDto object 分页对象 是

# 请求数据

{
  "id":"Onxj62b",
  "pageDto" : {          // 分页信息
    "pageSize" : 20,   // 每页显示数量
    "pageNum" : 1      // 页码 (从1开始)
   }
}

# 返回数据

{
    "code": 0,
    "msg": null,
    "data": [{
    	"id":"Onxj62b",
    	"name":"模板名称",
    	"type":1, // 模板类型 1：文本 2：语音
    	"content":"模板内容",
    	"fileName":"voice.wav",// 语音文件名称
    	"createTime":1646286831382,
    	"updateTime":1646286831482
    }],
    "pageDto" : {
        "pageSize" : 20,
        "pageNum" : 1,
        "count" : 100,
        "totalPageNum" : 5
    }
}

← 回调消息 →