创建项目
创建项目接口说明
此接口用于创建项目,一个项目即对应于一个语音模板,不同的语音模板需要对应不同的项目, 例如酒店核实订单项目和取消订单项目就对应不同的语音模板,所以需要创建不同的项目
接口地址
POST http://dms.icsoc.net/api/v3/project/create
传递参数方式
将所有的参数组成一个json串,然后通过post的body传递
接口参数
字段 | 说明 |
---|---|
vccId | 企业ID,系统生成,一个企业ID下可以创建指定个数的项目,创建项目接口中需要此参数 |
proName | 项目名称,只用作标识,不做它用,最好指定一个能代表实际用途的名称 |
proCallerType | 外呼主叫号码显示类型(1-固定单一普通号码、2-轮询号码池号码、3-使用主叫路由、4-逗号分隔的号码列表) |
proCallers | 外呼显示主叫号码(需要在系统中配置后才能显示),该值为系统中配置的记录的ID,有两种类型,一种是固定号码、一种是号段,例如系统中配置了2条记录,1条为固定号码03162774000,对应的记录ID=100,1条为号段03162774010-03162774099,对应的记录ID=101,则当 proCallerType =1时,只能设置为“100”,当 proCallerType =2时,可以设置为“100,101”,表示在号码池03162774000、03162774010-03162774099这91个号码中轮询显示,每次外呼时随机从该号码池中获取一个号码显示,该字段可以设置多个ID,多个之间逗号分隔。注:该字段必须为后台配置过的号码,否则其他号码一律不能显示 |
proMode | 项目类型(11-验证码类型、12-固定语音类型、13-动态语音类型,需要TTS合成、14-ASR语音识别) |
signToken | 用于签名使用的秘钥,最好使用哈希后的字符串,如果不提供,系统将随机生成一个 |
isCallback | 是否需要回调(0不需要1需要),默认为不需要 |
retUrl | 回调的URL地址 |
isSecret | 发送拨打数据的接口是否需要加密,(0不需要,1需要,默认为0) |
retFields | 回调返回的字段,多个字段逗号分隔,可用字段包括:"jobId":"应用自定义ID"; "pro_id":"项目ID"; "call_id":"呼叫ID"; "task_id":"任务ID"; "task_num":"被叫"; "server_num":"主叫"; "task_state":"呼叫结果,0为呼通、1为未呼通"; "insert_time":"收到数据时间(Linux时间戳)"; "start_time":"开始呼叫的时间"; "ring_time":"振铃时间"; "ans_time":"接通时间"; "end_time":"结束时间"; "called_times":"呼叫次数"; "task_cusresult":"收取的按键"; "asr_str":"如果是ASR项目会返回识别结果";"end_type":"挂机方,0:未接通;1:接通后用户挂机;2:接通后系统挂机" |
返回结果
返回结果为该项目的所有配置信息,格式为json,包含如下字段:
code
结果编码msg
结果信息lastId
生成的项目ID(proId)token
项目对应的签名token
结果编码说明
code | 说明 |
---|---|
200 | ok |
400 | 参数为空 |
401 | 企业ID为空 |
402 | 项目名称为空 |
403 | proCallerType设置不正确 |
404 | proMode设置不正确 |
405 | isSecret设置不正确 |
406 | isCallback设置不正确 |
407 | 当isCallback为1时retUrl不能为空 |
408 | 回调字段设置错误 |
409 | vccId不正确 |
410 | 超出最大任务数限制 |
411 | 当proCallerType=1时只能传固定号码的记录ID,当proCallerType=2时只能传号码段记录ID,当proCallerType=4时只能传号码列表 |
412 | proCallers不正确(当proCallerType=4时,任意一个proCallers不满足,则会提示此错误) |
500 | 创建项目失败 |