有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能说明

数据万象支持自定义设置回调 URL,在任务完成后,系统向该 URL 发送 HTTP POST 请求,请求体中包含通知内容。您可通过配置的回调地址及时了解任务处理的进展和状态,以便进行其他业务操作。

回调内容

任务完成后,系统会向您设置的回调地址发送回调内容,该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<EventName>TaskFinish</EventName>
<JobsDetail>
<Code>Success</Code>
<CreationTime>2022-06-30T19:33:18+0800</CreationTime>
<EndTime>2022-06-30T19:33:24+0800</EndTime>
<JobId>j707f4864f86811ecb90d0b03267ce0e5</JobId>
<Message/>
<Operation>
<MediaInfo>
<Format/>
<Stream>
<Audio>
<CodecName>mp3</CodecName>
<SampleRate>16000</SampleRate>
</Audio>
<Subtitle/>
<Video/>
</Stream>
</MediaInfo>
<MediaResult>
<OutputFile>
<Bucket>test-123456789</Bucket>
<Md5Info>
<Md5>5b2ca33cd7357abb1e0ea29f57544df9</Md5>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
</Md5Info>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
<ObjectPrefix/>
<Region>ap-chongqing</Region>
</OutputFile>
</MediaResult>
<Output>
<Bucket>test-123456789</Bucket>
<Object>output/aixiaonan.mp3</Object>
<Region>ap-chongqing</Region>
</Output>
<TtsConfig>
<Input>你好,我是爱晓楠,很高兴认识你。</Input>
<InputType>Text</InputType>
</TtsConfig>
<TemplateId>t1f1ae1dfsdc9ds41dsb31632d457ds6s2a</TemplateId>
<TemplateName>template_tts</TemplateName>
</Operation>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<StartTime>2022-06-30T19:33:19+0800</StartTime>
<State>Success</State>
<Tag>Tts</Tag>
</JobsDetail>
</Response>
具体的数据内容如下:
节点名称(关键字)
父节点
描述
类型
Response
保存结果的容器
Container
Container 节点 Response 的内容:
节点名称(关键字)
父节点
描述
类型
EventName
Response
固定值,为 TaskFinish
String
JobsDetail
Response
任务的详细信息
Container
Container 节点 JobsDetail 的内容: 同提交语音合成任务接口中的 Response.JobsDetail</
如果任务是通过工作流触发的,Response.JobsDetail.Input 还会包含 CosHeaders 节点,类型为 Container 数组。
Container 节点 CosHeaders 的内容:
节点名称(关键字)
父节点
描述
类型
Key
Response.JobsDetail.Input.CosHeaders
自定义 Header 的名称
String
Value
Response.JobsDetail.Input.CosHeaders
自定义 Header 的值
String
如果任务是通过工作流触发的,Response.JobsDetail 还会包含 Workflow 节点,类型为 Container。
Container 节点 Workflow 的内容:
节点名称(关键字)
父节点
描述
类型
RunId
Response.Workflow
工作流实例 ID
String
WorkflowId
Response.Workflow
工作流 ID
String
WorkflowName
Response.Workflow
工作流名称
String
Name
Response.Workflow
工作流节点名称
String

实际案例

案例 1:通过任务接口触发的任务回调

<Response>
<EventName>TaskFinish</EventName>
<JobsDetail>
<Code>Success</Code>
<CreationTime>2022-06-30T19:33:18+0800</CreationTime>
<EndTime>2022-06-30T19:33:24+0800</EndTime>
<JobId>j707f4864f86811ecb90d0b03267ce0e5</JobId>
<Message/>
<Operation>
<MediaInfo>
<Format/>
<Stream>
<Audio>
<CodecName>mp3</CodecName>
<SampleRate>16000</SampleRate>
</Audio>
<Subtitle/>
<Video/>
</Stream>
</MediaInfo>
<MediaResult>
<OutputFile>
<Bucket>test-123456789</Bucket>
<Md5Info>
<Md5>5b2ca33cd7357abb1e0ea29f57544df9</Md5>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
</Md5Info>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
<ObjectPrefix/>
<Region>ap-chongqing</Region>
</OutputFile>
</MediaResult>
<Output>
<Bucket>test-123456789</Bucket>
<Object>output/aixiaonan.mp3</Object>
<Region>ap-chongqing</Region>
</Output>
<TtsConfig>
<Input>你好,我是爱晓楠,很高兴认识你。</Input>
<InputType>Text</InputType>
</TtsConfig>
<TemplateId>t1f1ae1dfsdc9ds41dsb31632d457ds6s2a</TemplateId>
<TemplateName>template_tts</TemplateName>
</Operation>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<StartTime>2022-06-30T19:33:19+0800</StartTime>
<State>Success</State>
<Tag>Tts</Tag>
</JobsDetail>
</Response>

案例 2:通过工作流触发的任务回调

<Response>
<EventName>TaskFinish</EventName>
<JobsDetail>
<Code>Success</Code>
<CreationTime>2022-06-30T19:33:18+0800</CreationTime>
<EndTime>2022-06-30T19:33:24+0800</EndTime>
<JobId>j707f4864f86811ecb90d0b03267ce0e5</JobId>
<Message/>
<Operation>
<Input>
<CosHeaders>
<Key>Content-Type</Key>
<Value>application/octet-stream</Value>
</CosHeaders>
<CosHeaders>
<Key>x-cos-request-id</Key>
<Value>NjJiZDYwYTFfNjUzYTYyNjRfZjEwZl8xMmZhYzY5</Value>
</CosHeaders>
<CosHeaders>
<Key>EventName</Key>
<Value>cos:ObjectCreated:Put</Value>
</CosHeaders>
<CosHeaders>
<Key>Size</Key>
<Value>265</Value>
</CosHeaders>
</Input>
<MediaInfo>
<Format/>
<Stream>
<Audio>
<CodecName>mp3</CodecName>
<SampleRate>16000</SampleRate>
</Audio>
<Subtitle/>
<Video/>
</Stream>
</MediaInfo>
<MediaResult>
<OutputFile>
<Bucket>test-123456789</Bucket>
<Md5Info>
<Md5>5b2ca33cd7357abb1e0ea29f57544df9</Md5>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
</Md5Info>
<ObjectName>/output/aixiaonan.mp3</ObjectName>
<ObjectPrefix/>
<Region>ap-chongqing</Region>
</OutputFile>
</MediaResult>
<Output>
<Bucket>test-123456789</Bucket>
<Object>output/aixiaonan.mp3</Object>
<Region>ap-chongqing</Region>
</Output>
<TtsConfig>
<Input>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/text.txt</Input>
<InputType>Url</InputType>
</TtsConfig>
<TemplateId>t1f1ae1dfsdc9ds41dsb31632d457ds6s2a</TemplateId>
<TemplateName>template_tts</TemplateName>
</Operation>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<StartTime>2022-06-30T19:33:19+0800</StartTime>
<State>Success</State>
<Tag>Tts</Tag>
<Workflow>
<Name>Tts_1581665960537</Name>
<RunId>ic90edd59f84f11ec9d4f525400a3c59f</RunId>
<WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
<WorkflowName>workflow-test</WorkflowName>
</Workflow>
</JobsDetail>
</Response>

案例 3:通过工作流触发的任务回调, 格式为 JSON

{
"EventName": "TaskFinish",
"JobsDetail": {
"Code": "Success",
"CreationTime": "2022-06-30T19:33:18+0800",
"EndTime": "2022-06-30T19:33:24+0800",
"JobId": "j707f4864f86811ecb90d0b03267ce0e5",
"Operation": {
"Input": {
"CosHeaders": [{
"Key": "Content-Type",
"Value": "application/octet-stream"
},
{
"Key": "x-cos-request-id",
"Value": "NjJiZDYwYTFfNjUzYTYyNjRfZjEwZl8xMmZhYzY5"
},
{
"Key": "EventName",
"Value": "cos:ObjectCreated:Put"
},
{
"Key": "Size",
"Value": "265"
}
]
},
"MediaInfo": {
"Stream": {
"Audio": {
"CodecName": "mp3",
"SampleRate": "16000"
}
}
},
"MediaResult": {
"OutputFile": {
"Bucket": "test-123456789",
"Md5Info": {
"Md5": "5b2ca33cd7357abb1e0ea29f57544df9",
"ObjectName": "/output/aixiaonan.mp3"
},
"ObjectName": "/output/aixiaonan.mp3",
"Region": "ap-chongqing"
}
},
"Output": {
"Bucket": "test-123456789",
"Object": "output/aixiaonan.mp3",
"Region": "ap-chongqing"
},
"TtsConfig": {
"Input": "https://test-123456789.cos.ap-chongqing.myqcloud.com/input/text.txt",
"InputType": "Url"
},
"TemplateId": "t1f1ae1dfsdc9ds41dsb31632d457ds6s2a",
"TemplateName": "template_tts"
},
"QueueId": "p2242ab62c7c94486915508540933a2c6",
"StartTime": "2022-06-30T19:33:19+0800",
"State": "Success",
"Tag": "Tts",
"Workflow": {
"Name": "Tts_1581665960537",
"RunId": "ic90edd59f84f11ec9d4f525400a3c59f",
"WorkflowId": "web6ac56c1ef54dbfa44d7f4103203be9",
"WorkflowName": "workflow-test"
}
}
}