不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartJob |
系统规定参数。取值:StartJob。 |
InstanceId | String | 是 | da37319b-6c83-4268-9f19-814aed62e401 |
实例id |
JobJson | String | 是 | {"extras":[{"value":"2019-08-21 09:49:59.0","key":"djrq"}],"contacts":[{"phonenumber":"1816*******","name":"张三","referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed","honorific":"张先生"}]} |
作业数据 |
ScenarioId | String | 是 | af81a389-91f0-4157-8d82-720edd02b66a |
场景id,为了兼容旧版外呼功能。可不填。 |
JobGroupId | String | 否 | 4f21446e-324e-46f2-bf62-7f341fb004ea |
作业组id |
CallingNumber.N | RepeatList | 否 | 10086 |
主叫号码列表 |
ScriptId | String | 否 | b9ff4e88-65f9-4eb3-987c-11ba51f3f24d |
话术id,必填。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CallIds | Array of KeyValuePair |
通话ID列表 |
|
Key | String | c93cdd1c-f9b5-4758-be43-7a237a7eaa1d |
联系人第三方id,referenceId。 |
Value | String | 62229628-45d8-41bd-a80f-6e4c0a39f79b |
通话ID |
Code | String | OK |
响应码 |
HttpStatusCode | Integer | 200 |
HTTP状态码 |
Message | String | Success |
响应信息 |
RequestId | String | 8a621aa1-d2e7-43f3-b54d-8830af73c468 |
请求ID |
Success | Boolean | true |
是否成功 |
TaskIds | Array of KeyValuePair |
联系人第三方id和外呼系统任务id的映射 |
|
Key | String | c93cdd1c-f9b5-4758-be43-7a237a7eaa1d |
联系人第三方id |
Value | String | 62229628-45d8-41bd-a80f-6e4c0a39f79b |
外呼系统任务id |
示例
请求示例
http(s)://[Endpoint]/?Action=StartJob
&InstanceId=da37319b-6c83-4268-9f19-814aed62e401
&JobJson={"extras":[{"value":"2019-08-21 09:49:59.0","key":"djrq"}],"contacts":[{"phonenumber":"1816*******","name":"张三","referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed","honorific":"张先生"}]}
&ScenarioId=af81a389-91f0-4157-8d82-720edd02b66a
&<公共请求参数>
正常返回示例
XML
格式
<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>f765d3ee-ec03-4765-b235-6877501d99d1</RequestId>
<TaskIds>
<key>c93cdd1c-f9b5-4758-be43-7a237a7eaa1d</key>
<value>62229628-45d8-41bd-a80f-6e4c0a39f79b</value>
</TaskIds>
<Success>true</Success>
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"RequestId": "f765d3ee-ec03-4765-b235-6877501d99d1",
"TaskIds": [
{
"key":"c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
"value":"62229628-45d8-41bd-a80f-6e4c0a39f79b"
}
],
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
404 | NotExist.JobGroup | The specified JobGroup does not exist. | 指定的任务组不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。