文档

API接口常见问题

API常见问题汇总。

1、下发任务的时候,每次都要CreateJobGroup吗?

需要每次创建JobGroup,任务组是外呼任务的逻辑分组,比如同一天的外呼任务,同一批次的外呼任务,可以定义在同一任务组中。针对同一个JobGroup,可以,循环多次调用AssignJobs接口下发任务。为保证AssignJobs的性能,建议每次调用任务数控制在25个。

2、任务完成消息,消息中会返回任务Id怎么和调用方发起的任务返回参数对应

任务完成消息不需要与AssignJobs接口的返回值进行关联。AssignJobs接口的入参中的phoneNumber和referenceId可以与消息体中对应的值做关联。一个Job对应一个联系人,联系人信息中包含了phoneNumber,referenceId(业务对于当前联系人的唯一标识,类似会员号等)等参数。

3、mq接入流程:(a.依赖包版本b.消息类型是否是普通消息)

a MQ依赖的版本参考MQ文档。b普通消息即可。

4、MQ服务官网列表

https://www.aliyun.com/product/rocketmq?spm=a2c4g.11186623.2.9.291c2545nsym2O

5、对接后接口调用顺序:

先调用CreateJobGroup,然后调用AssignJobs。具体详见开发者指南,快速集成:(https://help.aliyun.com/document_detail/166158.html?spm=a2c4g.11186623.6.561.140b59afLUhSYJ

6、如何知道号码命中标签情况(或者哪个接口提供号码命中标签的情况):

每个任务呼叫完成会发送任务完成消息。消息中包含了下发任务时候的客户号码以及任务id。拿到任务id,通过DescribleJob就可以获取到当前任务的通话过程中命中的标签信息。DescribeJob中的Summary是当前任务通话过程命中的所有的标签和值。Summary.SummaryName:标签名称 Summary.Content:标签值。Summary中存储的是标签信息。

7、如何订阅消息队列:

参考:https://help.aliyun.com/document_detail/29551.html

https://help.aliyun.com/document_detail/169008.html?

8、开通RocketMQ后,该如何获取外呼的任务完成信息。

首先联系智能外呼产品运营同学,并提供如下信息:

1)子账号aksk(含外呼、RocketMQ权限)

2)RocketMQ的topicid及groupid。

3)外呼业务ID

4)RocketMQ消息队列实例信息

9、配置好RocketMQ消息队列后,无法获取外呼任务完成消息是怎么回事?

需要检查自己建立的RocketMQ实例是否为公网实例,如果所建RocketMQ实例非公网实例则无法获取外呼任务完成的消息队列信息

10、获取作业组状态,需要调用哪个接口?作业组状态又有哪些?

获取作业组状态接口为DescribeJobGroup,作业组状态分别为:Scheduling(0)调度中、Executing(1)执行中、Succeed(2)成功、Paused(3)挂起、Failed(4)失败、Cancelled(5)取消

11、接口常见报错提示鉴别

1、调用接口时返回提示为:Permission.Instance : You are not permitted to operate this instance. User=123456789, Instance=null.

需要自查以下几点:

1)对于需要传入外呼实例ID的情况,需要检查实例ID是否属于对应租户,是否越权使用

2)对于不需要传入外呼实例的情况,检查是否传入了用户相关ID,以及aksk,检查是否正确

3)以上2点检查无误后,检查访问外呼接口的出口IP是否在RAM中配置了IP白名单,对于新增的机器可能出现此类情况

2、调用CreateJobGroup接口返回提示为:Handle job group error

需要自查以下几点:

1)检查代码中调用的场景(ScriptId)是否处于已发布状态,如果为草稿态是无法发起外呼任务的;

2)检查所调用的场景是否已在控制台内删除掉了。

3)话术ID是否属于对应的业务ID。

4)如果是用户新增了服务器,检查新服务IP出口,是否配置了RAM鉴权的访问外呼产品IP白名单。

3、调用AssignJobs接口时提示:ParameterNull.Job

需要自查代码中JobJson是否有上传。

4、AssignJobs中honorific必传么?

image

此为必填项,内容随便写。如果话术中使用不到name和honorific,就随意传,随意就是啥都行,具体内容后端不校验,用户如果不使用也要传。 一般外呼场景中会用到name和honorific,这里传了,话术里面就直接替换了。

5、调用ModifyJobGroup接口时,报错提示:Handle job group error;

调用ModifyJobGroup接口进行修改作业组信息,作业组(任务组)必须是草稿态或挂起状态下才可以被修改,如果是其他状态(已完成、调度中、暂停、停止),则不允许进行改动。需要自查对应的任务组状态情况。

  • 本页导读 (0)
文档反馈