5. 对接三方接口列表

5.1 AAA黑名单管理

5.1.1 黑名单鉴权

基本信息

Path： 三方提供

Method： POST

接口描述： 无

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
number	string	必须		查询号码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
statusCode	String	必须		请求状态码。000000（成功）
msg	String	必须		状态码描述
result	String	非必须		查询结果。‘0’-不在黑名单 ‘1’-在黑名单

5.2 短信功能

5.2.1 IVR短信触发请求

基本信息

Path： /api/v1/config/openapi/sms/send

Method： POST

接口描述：

IVR获取bot响应的短信发送命令，将短信需要的配置参数传递给三方接口，三方按照参数进行短信发送。 注意：节点勾选了发送短信后，该节点返回重复话术时会再次触发发送短信。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json;charset=UTF-8	是

Body

名称	类型	是否必须	默认值	备注	其他信息
templateId	String	是	无	短信模板ID
callId	String	是	无	call id
phone	String	是	无	接收短信的号码，呼入场景下为主叫，外呼场景下为被叫
params	JSON	是	{}	bot流程的动态参数	bot流程里的所有变量及其值，如果没有变量则为{}，1.5.4版本里呼入场景下，这个参数为随路数据

请求示例

{
    "templateId":"1163347",
    "callId":"20202011010201",
    "phone":"05715623544532",
    "params":{
        "value":"3333",
        "account":1000,
        "account2":500,
        "name":"测试",
        "sex":"男",
        "age":"22"
    }
}
 
// 响应实例
// 成功:
{
    "msg": "SUCCESS",
    "code": 0
}
失败:
{
    "msg": "号码格式有误",
    "code": 160042
}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	Integer	是	无	短信是否发送成功	0表示成功,其他表示异常
msg	String	是	无	短信发送失败的原因	失败的原因，如果成功则为"success"