API文档

# 发起外呼

# 接口说明

项 值
URL /v1/call/callOut.json
描述 发起外呼
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
userId String 外呼坐席用户ID 是
mobile String 手机号 是

# 请求数据

{
    "userId": "BxSdn9pnIz", // 外呼坐席用户编号
    "mobile": "12344445555" // 手机号
}

# 返回数据

{
    "code" : 0,
    "msg" : "",
    "data" : "NskquQalKZ" // 外呼记录ID
}

# 创建语音外呼

# 接口说明

项 值
URL /v1/call/voiceCall.json
描述 创建语音外呼
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
Mobile string 手机号，仅支持中国大陆手机号: 11位数字，例如 1xxxxxxxxxx 是
TplId string 模板id 是
TplParams Json 模板变量信息。例如模板如下：你的验证码{code},有效期为五分钟。其中code是模块变量，则TplParams参数值格式为：{“code”:123456},如果你的模板没有变量，则该参数值为: {} 。注意：最终拼接后的内容长度限制200个字符 是

# 请求数据

{
    "Mobile": "138XXXX1234",
    "TplId":"xx",
    "TplParams": {"code": 123456}
}

# 成功返回数据

{
    "CallId": "fLTxMRxQHh"
}

# 失败返回数据

{
  "Error": {
    "Type": "server",
    "Message": "The Account do not call voice service",
    "Code": "AccountVoiceServiceUnavailable"
  }
}

← 外呼成员 →