文档

StartJob - 创建一个作业

更新时间:

不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 id

da37319b-6c83-4268-9f19-814aed62e401
JobGroupIdstring

作业组 id

4f21446e-324e-46f2-bf62-7f341fb004ea
ScenarioIdstring

场景 id,为了兼容旧版外呼功能。可不填。

af81a389-91f0-4157-8d82-720edd02b66a
JobJsonstring

作业数据

{"extras":[{"value":"2019-08-21 09:49:59.0","key":"djrq"}],"contacts":[{"phonenumber":"1816*******","name":"张三","referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed","honorific":"张先生"}]}
ScriptIdstring

话术 id,2020 年 2 月份后创建的话术,该字段必填

b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
CallingNumberarray

主叫号码列表

string

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
Codestring

响应码

OK
Messagestring

响应信息

Success
RequestIdstring

请求 ID

8a621aa1-d2e7-43f3-b54d-8830af73c468
Successboolean

是否成功

true
TaskIdsarray<object>

联系人第三方 id 和外呼系统任务 id 的映射

object
Keystring

联系人第三方 id

c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Valuestring

外呼系统任务 id

62229628-45d8-41bd-a80f-6e4c0a39f79b
CallIdsarray<object>

通话 ID 列表

object
Keystring

联系人第三方 id,referenceId。

c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Valuestring

通话 ID

62229628-45d8-41bd-a80f-6e4c0a39f79b

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "8a621aa1-d2e7-43f3-b54d-8830af73c468",
  "Success": true,
  "TaskIds": [
    {
      "Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
      "Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
    }
  ],
  "CallIds": [
    {
      "Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
      "Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
    }
  ]
}

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "8a621aa1-d2e7-43f3-b54d-8830af73c468",
  "Success": true,
  "TaskIds": [
    {
      "Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
      "Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
    }
  ],
  "CallIds": [
    {
      "Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
      "Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
404NotExist.JobGroupThe specified JobGroup does not exist.指定的任务组不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史