2.8 通话接口
2.8.1 流程外呼(需要在现有流程导出植入外呼节点)
基本信息
Path: /api/v1/config/openapi/calls/callout
Method: POST
接口描述:参考callout_demo.xml改造
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
attachData | object | 非必须 | 随路数据(json格式) | ||
callBackUrl | string | 非必须 | 回调地址 | ||
called | string | 必须 | 外呼号码 | ||
companyId | integer | 非必须 | 企业id | ||
flowId | integer | 必须 | 流程id | ||
showCaller | string | 必须 | 显号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.8.2 双向回呼
基本信息
Path: /api/v1/config/openapi/calls/callback
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
attachData | object | 非必须 | json | ||
callBackUrl | string | 非必须 | 回调地址 | ||
called | string | 必须 | 被叫 | ||
companyId | integer | 非必须 | 企业id | ||
operatorId | string | 必须 | 坐席工号 | ||
phoneType | integer | 必须 | 0:sip号码 1:真实号码 | ||
showCaller | string | 必须 | 显号 坐席主技能组默认(外呼显示号码) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |