tencent cloud

Feedback

Task Callback Content

Last updated: 2021-12-31 17:23:38

    Feature Description

    CI supports user-defined callback URLs. After a task is completed, the system sends an HTTP POST request whose body contains notification content to a user-defined callback URL. You can use the configured callback URL to learn about the processing progress and status of the task so that you can perform other operations as needed.

    Callback Content

    After the task is completed, the system sends the callback content to the callback URL that you configure. The response body is returned as application/xml data. The following contains all the nodes:

    <Response>
         <JobsDetail>
             <Code></Code>
             <Message></Message>
             <JobId></JobId>
             <State></State>
             <CreationTime></CreationTime>
             <EndTime></EndTime>
             <QueueId></QueueId>
             <Tag></Tag>
             <Input>
                   <CosHeaders></CosHeaders>
                   <Region></Region>
                   <BucketId></BucketId>
                   <Object></Object>
             </Input>
             <Operation>
                   <TemplateId></TemplateId>
                   <TemplateName></TemplateName>
                   <MediaResult></MediaResult>
                   <Output>
                      <Region></Region>
                      <Bucket></Bucket>
                      <Object></Object>
                   </Output>
                   <MediaInfo>
                   </MeidaInfo>
             </Operation>
             <Workflow>   
                   <RunId></RunId>   
                   <WorkflowId></WorkflowId>  
                   <WorkflowName></WorkflowName>  
                   <Name></Name>
             </Workflow>
         </JobsDetail>
    </Response>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    Response None Response container Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    JobsDetail Response Task details Container

    JobsDetail has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Code Response.JobsDetail Error code, which is meaningful only if State is Failed String
    Message Response.JobsDetail Error description, which is meaningful only if State is Failed String
    JobId Response.JobsDetail Task ID String
    Tag Response.JobsDetail Task tag String
    State Response.JobsDetail Task status: Success or Failed String
    CreationTime Response.JobsDetail Task creation time String
    EndTime Response.JobsDetail Task end time String
    QueueId Response.JobsDetail ID of the queue where the task is in String
    Input Response.JobsDetail Input resource address of the task Container
    Operation Response.JobsDetail Operation rule. Up to 6 operation rules are supported. Container
    Workflow Response.JobsDetail Information about the workflow to which the task belongs Container

    Input has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    CosHeaders Response.JobsDetail.Input Custom header information of the input file, in array format. There can be multiple headers. This node is included only for workflow-triggered tasks. Container
    Object Response.JobsDetail.Input Name of the input file, i.e., object key (ObjectKey) in COS String
    Region Response.JobsDetail.Input Region of the input bucket String
    BucketId Response.JobsDetail.Input ID of the input bucket String

    CosHeaders has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Key Response.JobsDetail.Input.CosHeaders Name of the custom header String
    Value Response.JobsDetail.Input.CosHeaders Value of the custom header String

    Operation has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    TemplateId Response.JobsDetail.Operation Task template ID String
    TemplateName Response.JobsDetail.Operation Task template name String
    Output Response.JobsDetail.Operation File output address Container
    MediaResult Response.JobsDetail.Operation Task output information Container
    MediaInfo Response.JobsDetail.Operation Transcoding output video information. Not returned when there is no output video. Container

    Output has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Region Response.Operation.Output Bucket region String
    Bucket Response.Operation.Output Result storage bucket String
    Object Response.Operation.Output Result file name String

    MediaResult has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    OutputFile Response.Operation.MediaResult Information about the actual output file Container

    OutputFile has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Region Response.Operation.MediaResult.OutputFile Bucket region String
    Bucket Response.Operation.MediaResult.OutputFile Result storage bucket String
    ObjectPrefix Response.Operation.MediaResult.OutputFile Output filename prefix String
    ObjectName Response.Operation.MediaResult.OutputFile List of output filenames, in array format String
    Note:

    The actual output file is the StringConcat(ObjectPrefix,ObjectName) file in the bucket specified by Bucket in the region specified by Region.

    Workflow has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    RunId Response.Workflow Workflow instance ID String
    WorkflowId Response.Workflow Workflow ID String
    WorkflowName Response.Workflow Workflow name String
    Name Response.Workflow Workflow node name String

    MediaInfo has the following sub-nodes:
    Same as the Response.MediaInfo node in the GenerateMediaInfo API.

    Examples

    <Response>
      <JobsDetail>
          <Code>Success</Code>
          <CreationTime>2020-11-16T16:43:29+0800</CreationTime>
          <EndTime>2020-11-16T16:43:33+0800</EndTime>
          <Input>
              <CosHeaders>
                  <Key>x-cos-meta-test</Key>
                  <Value>testvalue</Value>
              </CosHeaders>
              <CosHeaders>
                  <Key>x-cos-meta-name</Key>
                  <Value>xxxxxx</Value>
              </CosHeaders>
              <CosHeaders>
                  <Key>x-cos-meta-age</Key>
                  <Value>10</Value>
              </CosHeaders>
              <Object>1/2/3/4/5/xxx.mp4</Object>
              <Region>ap-beijing</Region>
              <BucketId>examplebucket-1250000000</BucketId>
          </Input>
          <JobId>jccddc41c27e711ebbff5874bc5b36868</JobId>
          <Message/>
          <Operation>
              <MediaResult>
                  <OutputFile>
                      <Bucket>examplebucket-1250000000</Bucket>
                      <ObjectName>1/2/Conversion to mp4-xxx_iccba81fa27e711eb989d525400276c76.mp4</ObjectName>
                      <ObjectPrefix/>
                      <Region>ap-chongqing</Region>
                  </OutputFile>
              </MediaResult>
              <Output>
                  <Bucket>examplebucket-1250000000</Bucket>
                  <Object>1/2/Conversion to mp4-xxx_iccba81fa27e711eb989d525400276c76.${ext}</Object>
                  <Region>ap-chongqing</Region>
              </Output>
              <TemplateId>t182c0ca7d91ca40969a3fc97c5559091a</TemplateId>
              <TemplateName>example</TemplateName>
          </Operation>
          <Workflow>   
              <RunId>rccddc41c27e711ebbff5874bc5b36868</RunId>   
              <WorkflowId>wccddc41c27e711ebbff5874bc5b36868</WorkflowId>  
              <WorkflowName>workflow</WorkflowName>  
              <Name>Transcode_1600413767444</Name>
          </Workflow>
          <QueueId>p791b0bca54ee44289f0d4b1d90796c4f</QueueId>
          <State>Success</State>
          <Tag>Transcode</Tag>
      </JobsDetail>
    </Response>
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support