1.1 接口说明

通过接口调用的方式发起外呼IVR。

1.2 调用URL

https://ykf.uincall.com/openapi/uincall/ivrCallout?tenant_id=acf528a2-d0e2-4a7b-8513-74cb39xxxxxx&access_token=500b0c34de27bb2eb0212886edxxxxxx

1.3 调用方式

POST

1.4 传入参数

非必填参数，调用接口时请传递参数名，参数值可为空

序号 名称 类型 是否必填 说明
1 command String 是 定值”play_ivr”
2 dnis String 是 被叫号码（要打给谁）
3 memo String 是 外显号码（云客服->设置->呼叫中心设置->外显号设置中获取）
4 ivr_id String 是 流程标识，可在云客服界面查看
5 ivr_first_id String 是 流程标识首节点编号，可在云客服界面查看
6 remark String 否 自定义扩展业务参数，JSON格式字符串

ivr_id 参数获取位置：

ivr_first_id 参数获取位置：

1.5 响应参数

序号 名称 类型 说明
1 errcode Integer 状态码：0成功，其他非0错误码，详见错误码列表
2 errmsg String 状态说明
3 data JsonObject类型数组 Object数组
3.1 session_id String 呼叫会话记录唯一标识

1.6 使用样例

【调用】

url：https://ykf.uincall.com/openapi/uincall/ivrCallout?tenant_id=acf528a2-d0e2-4a7b-8513-74cb39xxx&access_token=500b0c34de27bb2eb0212886edxxx

1.3 调用方式

【POST数据】
{
    "command": "play_ivr",
    "dnis": "18710783340",
    "memo": "02863208372",
    "ivr_id": "40c1d8e3fe885ed92e46c4cad9ca6d1a",
    "remark": ""
}
【响应】
{
    "errcode": 0,
    "errmsg": "success",
    "data": {"session_id": "xxxxxxxxxx"}
}
文档更新时间: 2024-04-26 14:23   作者：admin