服务端
服务端API文档

外呼

更新时间: 2022/08/30 08:22:07

外呼

URL

  • 请求方法:POST
  • URL:http://voip-host/api/v1/voip/cti/app/call/out

请求参数

参数名称 类型 是否必选 示例 描述
appId string 必填 eca23f68c66d4acfceee77c200200359 应用ID。
seatId string 必填 12345 坐席ID,坐席登陆的时候传入seatid和sipAccount的绑定关系。
callId string 选填 90935c19-c21c-436b-a480-4c5121da745d 会话ID,整个会话的唯一标识,会贯穿整个流程。应用下需全局唯一,不填则随机生成。
didNumber string 选填 057122931792 中继号码。不填则在应用下随机选择中继号。
phone string 必填 15700084166 外呼手机号码。

返回参数

参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。
data string {"tenant":"cleverdj", . . . } 查询到的数据信息,json格式返回。
didNumber string 057122931792 中继号码。
callId string 90935c19-c21c-436b-a480-4c5121da745d 会话id。

示例

请求示例

{
  "appId": "eca23f68c66d4acfceee77c200200359",
  "didNumber": "057122931792",
  "phone": "15700084166",
  "callId":"90935c19-c21c-436b-a480-4c5121da745d"
  "seatId": "123456serid"
}

正常返回示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "didNumber": "057122931792",
    "callId": "90935c19-c21c-436b-a480-4c5121da745d"
  }
}

错误码

  • body 中的错误码(code)

    该接口在 HTTP Body 中返回错误码(code),错误码列表请参考业务错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 外呼
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码