API接口

更新时间：2025-04-25 16:53:25

一、 AI智能外呼创建呼叫任务

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

1.1 协议说明

名称	说明
接口名称	AI智能外呼创建呼叫任务
协议	HTTPS POST
URL	https://api.253.com/open/ai_call/createTask
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

1.2 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	说明
appId	string	是	请在官网登录后获取，详情请看,功能介绍->接口详情
appKey	string	是	请在官网登录后获取，详情请看,功能介绍->接口详情
mobilesJson	string	是	被叫号码和变量，手机号字段key固定为客户手机号码，例如 [{"客户手机号码":"18912345678","name":"张三"},{"客户手机号码":"18911112222","name":"李四"}]（json格式的数组，单次最大10000），如果需要带短信变量，短信中的变量和传的变量数量和顺序需要一致, 例如：[{"客户手机号码":"18912345678","name":"张三","smsVar":["张三","男"]},{"客户手机号码":"18911112222","name":"李四","smsVar":["李四","女"]}]
templateId	string	是	模版Id
displayNum	string	是	主叫号码
taskName	string	否	任务名称(最大长度50)
sendType	int	否	任务发送类型 1-定时任务 2-即时任务, 不传为即时任务
taskStartTime	string	否	任务开始时间，yyyyMMddHHmmss，eg:20200902170000
billUrl	string	否	话单推送回调地址
transData	string	否	透传数据(话单推送回调时返回最大长度250)
maxRecallCount	int	否	最大重拨次数，只能0-1，0不重拨，默认值1 重拨1次
recallInterval	int	否	重拨间隔时长（分钟），只能1-1440，默认值60，最大重拨次数大于0时必传
noConnected	string	否	重播策略：被叫无法接通,true:重拨; false:不重拨, 默认值:true
noAnswer	string	否	重播策略：被叫无人接听,true:重拨; false:不重拨, 默认值:true
fmsStatus	string	否	闪信开启标识 0：关闭，1：开启
fmsTemplateId	string	否	闪信模板id
smsHangupStatus	string	否	挂机短信开启标识 0：关闭，1：开启
smsTemplateId	string	否	挂机短信模板id
smsSendType	int	否	挂机短信发送方式：0:接通后发送，1:全部群发，2:未接通发送，3:按接通时长发送，默认:0
smsSendLimit	int	否	当挂机短信方式为3时必填，单位秒，输入时间规则为大于等于x后发送挂机短信（整数输入大于等于1）

1.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
taskId	string	呼叫的任务id

1.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "taskId": "AICALL931******64224"
    },
    "code": "200000"
}

1.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

二、消息状态报告推送

2.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

2.2 推送格式说明

名称	说明
接口名称	消息状态报告推送
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

2.3 请求参数

数据回推方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
callId	string	是	调用ID号，每次调用生成唯一的ID号
callDesc	string	是	通话结束原因状态码详见code码
callDescMsg	string	是	通话结束原因状态码描述
callStatus	string	是	呼叫结果 0-成功 1-失败
mobile	string	是	被叫号码
startTime	string	是	开始呼叫时间，毫秒级时间戳
callTime	string	是	通话时长(s)
transData	string	是	透传数据
hangupCause	string	是	线路挂断原因
invokeTime	string	是	线路调用时间，毫秒级时间戳
ringTime	string	是	振铃时间，毫秒级时间戳
answerTime	string	是	接听时间，毫秒级时间戳
byeTime	string	是	挂断时间，毫秒级时间戳

2.4 建议返回结果（成功）

复制成功
{
    "message": "请求成功",
    "code": "200000"，
    "success": true
}

三、 AI智能外呼模版查询

3.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

3.2 协议说明

名称	说明
接口名称	AI智能外呼模版查询
协议	HTTPS POST
URL	https://api.253.com/data/open/aicall/script_list
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

3.3 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
appId	string	是	应用id
appKey	string	是	应用key

3.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>page	int	当前页码
data>>size	int	当前页面大小
data>>total	int	总数
data>>list	Array	当前页码
data>>list>>id	int	模板id，创建任务使用此id
data>>list>>name	string	模板名称
data>>list>>status	int	模板状态：1：审核中，2：审核未通过，3：待发布，4：已发布
data>>list>>type	int	模板类型：1普通话术 2动态话术
data>>list>>createTime	string	创建时间
data>>list>>lastUpdateTime	string	更新时间
data>>list>>templateField	string	动态话术变量(json格式的数组)

3.5 返回数据示例（成功）

复制成功
{
	"message": "请求成功",
	"data": {
		"page": 1,
		"size": 1,
		"total": 1,
		"list": [
			{
				"id": 15038,
				"name": "测试话术",
				"status": 4,
				"type": 2,
				"createTime": "2022-09-08 17:24:55",
				"lastUpdateTime": "2022-09-15 16:45:50",
				"templateField": "[\"客户手机号码\",\"USER_ADDR1\",\"ADDR_DETAIL\",\"PHONE_CONTENT\",\"CALLER_TAIL\",\"WAY_BILL_NUM_PAUSE\",\"HIS_WAYBILL_FIRST\",\"ORDER_DIGITAL_NUM_PAUSE\",\"VARS_ADDRESS\",\"ORDER_PERIOD_ADDR\",\"T_NET_PHONE\",\" \",\"LAST_FOUR_ORDER\",\"ADDR_RECEIVE_DETAIL\",\"PHONE_RECEIVE_CONTENT\",\"URGE_ZH_CREATE_TIME\",\"URGE_SEND_ADDRESS\",\"RETURN_ADDRESS\",\"FIRST_WAY_PROCESS_INFO\",\"FIRST_SENDER_ADDRESS\",\"LAST_PROCESS_INFO\",\"网点名称\",\"网点电话\"]"
			}
		]
	},
	"code": "200000"
}

3.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

四、查询AI智能外呼主叫

4.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

4.2 协议说明

名称	说明
接口名称	查询AI智能外呼主叫
协议	HTTPS POST
URL	https://api.253.com/data/open/aicall/caller_list
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

4.3 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
appId	string	是	应用id
appKey	string	是	应用key

4.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Array	返回对象
data>>id	int	主叫id，创建任务指定主叫使用该id
data>>createTime	int	创建时间（示例 1655367238844）
data>>cpnStatus	int	主叫状态 1-启用；0-禁用

4.5 返回数据示例（成功）

复制成功
{
	"message": "请求成功",
	"data": [
		{
			"id": 726,
			"createTime": 1655367238844,
			"cpnStatus": 1
		}
	],
	"code": "200000"
}

4.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

五、 AI智能外呼调用记录查询

5.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

5.2 协议说明

名称	说明
接口名称	AI智能外呼调用记录查询
URL	https://api.253.com/data/open/aicall/call_list
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

5.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	string	是	应用id
appKey	string	是	应用key
startTime	string	否	调用时间开始（示例2024-05-25 15:16:46）
endTime	string	否	调用时间结束（示例2024-08-25 15:16:46）
mobile	string	否	被叫号码
callState	string	否	呼叫结果 0-成功 1-失败
callCode	string	否	结束原因
page	string	否	分页页码
size	string	否	分页大小

5.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>pageNum	int	当前页码
data>>pageSize	int	每页个数
data>>size	int	当前页个数
data>>startRow	int	由第几条开始
data>>endRow	int	到第几条结束
data>>pages	int	总页数
data>>prePage	int	上一页
data>>nextPage	int	下一页
data>>isFirstPage	boolean	是否为首页
data>>isLastPage	boolean	是否为尾页
data>>hasPreviousPage	boolean	是否有上一页
data>>hasNextPage	boolean	是否有下一页
data>>navigatePages	int	每页显示的页码个数
data>>navigatepageNums	Array	导航页码数
data>>navigateFirstPage	int	首页
data>>navigateLastPage	int	尾页
data>>total	int	总条数
data>>list	List	数据集合
data>>list>>jobId	long	通话jobId
data>>list>>bizTypeName	string	接口名称
data>>list>>taskId	string	任务Id
data>>list>>taskName	string	任务名称
data>>list>>mobile	string	被叫号码
data>>list>>retryCount	int	当前重播轮次
data>>list>>callTime	int	通话时长
data>>list>>callState	int	通话状态 0成功 1失败 2未知
data>>list>>callCode	string	通话挂断原因描述
data>>list>>content	string	通话内容
data>>list>>tags	string	通话标签
data>>list>>invokeTime	string	调用时间(示例 1722490576000)
data>>list>>backTime	string	话单返回时间(示例 1722490576000)
data>>list>>count	string	计费数量
data>>list>>startTime	string	开始呼叫时间 (示例 1722490576000)
data>>list>>ringTime	string	开始振铃时间 (示例 1722490576000)
data>>list>>answerTime	string	接听时间 (示例 1722490576000)
data>>list>>byeTime	string	挂断时间 (示例 1722490576000)
data>>list>>hangupCode	string	挂机短信状态码
data>>list>>hangupCodeDesc	string	挂机短信状态描述
data>>list>>fmsCode	string	闪信状态码
data>>list>>fmsCodeDesc	string	闪信状态描述
data>>list>>hangupSmsInvokeTime	string	挂机短信调用时间

5.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "pageNum": 1,
        "pageSize": 10,
        "size": 2,
        "startRow": 1,
        "endRow": 2,
        "pages": 1,
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1,
        "total": 2,
        "list": [
            {
                "id": 1268563196277424128,
                "jobId": 1268562922754277377,
                "bizTypeName": "AI智能语音",
                "taskId": "AICALL1268562922754277378",
                "taskName": "测试任务",
                "mobile": "17612105202",
                "retryCount": 1,
                "callTime": 49,
                "callState": 0,
                "callCode": "语音播放完成",
                "content": "",
                "tags": "",
                "invokeTime": "1722490576000",
                "backTime": "1722490635000",
                "count": "0",
                "startTime": "1722490576000",
                "ringTime": "1722490579000",
                "answerTime": "1722490586000",
                "byeTime": "1722490635000",
                "hangupCode": "0",
                "hangupCodeDesc": "关闭",
                "fmsCode": "0",
                "fmsCodeDesc": "关闭",
                "hangupSmsInvokeTime": ""
            },
            {
                "id": 1268563247296937984,
                "jobId": 1268562922754277376,
                "bizTypeName": "AI智能语音",
                "taskId": "AICALL1268562922754277378",
                "taskName": "测试任务",
                "mobile": "18972565158",
                "retryCount": 1,
                "callTime": 62,
                "callState": 0,
                "callCode": "语音播放完成",
                "content": "",
                "tags": "",
                "invokeTime": "1722490576000",
                "backTime": "1722490647000",
                "count": "0",
                "startTime": "1722490576000",
                "ringTime": "1722490578000",
                "answerTime": "1722490585000",
                "byeTime": "1722490647000",
                "hangupCode": "0",
                "hangupCodeDesc": "关闭",
                "fmsCode": "0",
                "fmsCodeDesc": "关闭",
                "hangupSmsInvokeTime": ""
            }
        ]
    },
    "code": "200000"
}

5.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

六、 AI智能外呼通话详情查询

6.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

6.2 协议说明

名称	说明
接口名称	查询主叫
协议	HTTPS POST
URL	https://api.253.com/data/open/aicall/call_detail
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

6.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	string	是	应用id
appKey	string	是	应用key
taskId	string	是	任务ID
jobId	string	否	作业组Id（jobId和mobile不能同时传空）
mobile	string	否	被叫号码（jobId和mobile不能同时传空）
recallCount	string	否	被叫轮次

6.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Array	返回对象
data>>taskName	string	任务名称
data>>callTime	string	通话时长
data>>callState	string	呼叫结果 0-成功 1-失败
data>>ringTime	string	振铃时长
data>>taskId	string	任务ID
data>>templateName	string	模版名称（外呼场景）
data>>msgId	string	消息ID（本通通话ID）
data>>accNo	int	账号（用户ID）
data>>plannedCallTime	string	计划呼叫时间
data>>actualCallTime	string	实际呼叫时间
data>>caller	string	呼叫者(主叫号码)
data>>callee	string	被呼叫人（被叫号码）
data>>dialogueRounds	int	对话轮数
data>>callIndex	int	呼叫序列号
data>>tagGroupNames	string	系统标签
data>>intention	string	意向标签
data>>recordUrl	string	录音地址
data>>sessionList	Array	对话数据
data>>sessionList>>dialogNodeSeq	int	对话节点序列号
data>>sessionList>>robotSay	string	机器人回复
data>>sessionList>>userSay	string	用户回复

6.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": [
        {
            "taskName": "测试任务",
            "callTime": "62",
            "callState": "0",
            "ringTime": "7",
            "taskId": "AICALL1268562922754277378",
            "templateName": "测试1",
            "msgId": "1268563247296937984",
            "accNo": 323,
            "plannedCallTime": "2024-08-01 13:36:16",
            "actualCallTime": "2024-08-01 13:36:16",
            "caller": "",
            "callee": "189xxxxxxxxxx",
            "dialogueRounds": 5,
            "callIndex": 1,
            "tagGroupNames": "问卷回答情况 问卷回答情况 问卷回答情况",
            "intention": "D",
            "recordUrl":"http://xxx"
            "sessionList": [
                {
                    "dialogNodeSeq": 1,
                    "robotSay": "[se40][p300]你好，区政府总值班室，下面进行值班电话问答，请用普通话回答。请问你单位今日值班人员叫什么名字？",
                    "userSay": "一"
                },
                {
                    "dialogNodeSeq": 1,
                    "robotSay": "[se40]区政府总值班室，下面进行值班电话问答，请用普通话回答。请问你单位今日值班人员叫什么名字？",
                    "userSay": "末位"
                },
                {
                    "dialogNodeSeq": 2,
                    "robotSay": "[se40]请问你单位今日值班领导是哪位？",
                    "userSay": "张三"
                },
                {
                    "dialogNodeSeq": 3,
                    "robotSay": "[se40]请问你单位辖区内今日社会面情况是否正常?",
                    "userSay": "正常"
                },
                {
                    "dialogNodeSeq": 4,
                    "robotSay": "[se40]好的，请务必牢总值班室电话：010-66015050 和市政府总值班室电话：021-23110290。如遇国务院总值班室或 市政府总值班室电话抽查，请第一时间反馈至区政府总值班室。感谢你的配合，再见。"
                }
            ]
        }
    ],
    "code": "200000"
}

6.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

七、查询挂机短信模板

7.1 版本说明

日期	版本	修订内容摘要
2024-08-23	v1.0.0	更新接口文档

7.2 协议说明

名称	说明
接口名称	查询挂机短信模板
URL	https://api.253.com/data/api/voiceMsg/querySmsTemplate
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

7.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大1000）
smsTemplateId	String	否	挂机短信模板id
smsTemplateState	String	否	挂机短信模板审核状态 0-审核中 1-通过审核 2-审核失败
smsTemplateAction	String	否	挂机短信标签
smsTemplateType	String	否	模板类型（默认全部 1 挂机短信，2 视频短信， 3 闪信）
startDate	String	是	开始调用时间（yyyy-MM-dd HH:mm:ss）
endDate	String	否	结束调用时间（yyyy-MM-dd HH:mm:ss）

7.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>total	int	查询总数
data>>pageSize	int	每页个数
data>>pageNum	int	页码
data>>list	List	模板数据
data>>list>>smsTemplateState	string	模板审核状态 0-审核中 1-通过审核 2-审核失败
data>>list>>createTime	string	模板创建时间 13位时间戳
data>>list>>smsTemplateName	string	模板名称
data>>list>>smsTemplateId	string	模板ID
data>>list>>auditRemark	string	审核评论
data>>list>>smsTemplateContent	string	模板内容
data>>list>>sign	string	模板签名
data>>list>>smsType	string	1 挂机短信 2 视频短信 3 闪信

7.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "total": 1,
        "pageSize": 10,
        "list": [
            {
                "smsTemplateState": "1",
                "createTime": "1689094655000",
                "smsTemplateName": "111*****1",
                "smsTemplateId": "1128******6608",
                "auditRemark": "",
                "smsTemplateContent": "你好，这是一个测试的示例短信，退订回T",
                "sign":"测试签名"，
                "smsType":"1"
            }
        ],
        "pageNum": 1
    },
    "code": "200000"
}

没有更多了

上一篇：AI智能外呼

没有下一篇

文档目录

收缩

产品中心

联系我们

热门搜索

中国站

国际站

API接口

一、 AI智能外呼创建呼叫任务

二、消息状态报告推送

三、 AI智能外呼模版查询

四、查询AI智能外呼主叫

五、 AI智能外呼调用记录查询

六、 AI智能外呼通话详情查询

七、查询挂机短信模板

热门搜索

中国站

国际站

API接口

一、 AI智能外呼创建呼叫任务

二、 消息状态报告推送

三、 AI智能外呼模版查询

四、 查询AI智能外呼主叫

五、 AI智能外呼调用记录查询

六、 AI智能外呼通话详情查询

七、 查询挂机短信模板

二、消息状态报告推送

四、查询AI智能外呼主叫

七、查询挂机短信模板