运营

发布/订单

总结 提交新订单
URL. / api / v1 /订单
详细说明 提交一个新的订单以便自动转录。订单请求包含两个主要元素:
  • 自动转录选项.本节包含对要转录的输入媒体的引用。有三个选项可以指定输入媒体:
    • 对象返回的uri发布到/输入在Location头文件中.如果媒体存储在您的系统中,或者可以通过URL下载,请使用此方法。
      首先,做一个发布到/输入向我们发送媒体。接下来,您可以使用返回的URI在订单请求中引用它。
    • external_link- 如果您有嵌入媒体的网页链接,则应使用此选项,但不是向媒体文件的链接。在API调用时,我们不会尝试使用这种方式指定的链接。这与您在与媒体文件链接的链接发布到/输入时进行对比 - 在这种情况下下载该文件。
      只有在无法直接链接到媒体文件时才应使用External_Link。
      如果external_link指向一个YouTube页面,我们可以自动确定视频在该页面上的持续时间。否则,您将需要显式指定媒体持续时间。

    对于任何输入,都必须提供uri或external_link,但不能同时提供两者。如果两者都提供或都不提供,则返回一个错误。

    对于每个输入,您可以明确指定输入所引用的视频的音频长度(以秒为单位)。如果您没有指定音频长度,我们将尝试从输入媒体自动确定它;然而,我们并非总能做到这一点。我们通常可以使用常见的音频/视频格式(例如mp3、aac、quicktime等)来计算文件的音频长度,这些格式的大小可达10MB。如果您的文件大于10MB或使用不常见的音频/视频格式,我们强烈建议您明确指定音频长度。

  • 通知信息.可选地,当订单进入一个新的状态(例如正在转录或审查)和当它完成时,您可以请求一个HTTP发布到您选择的url。
  • 宝,项目或部门.您可以选择添加PO、Project或Department来指定订单应该如何支付。仅当客户有发票时有效。

    最大长度:64。

付款将通过借记用户的帐户余额来完成。

请求标题
  • 授权- 包含客户端/用户API键
要求身体 XML或JSON包含有关订单的详细信息。有关示出使用字段的示例实体见下文。
响应 成功,201。
错误,400个不良请求。
响应头
  • 地点-标识新创建的订单的URI。这个URI可以用来请求订单的详细信息(比如状态)。仅在返回201响应代码时显示。
身体的反应 成功,空。出错,将包含一个<错误/>实体,具有更多详细信息。
错误代码
  • 10001缺失输入 - 如果订单请求不包含任何输入介质
  • 10002无效输入-如果其中一个输入媒体uri是无效的,例如不能识别通过POST上传到/输入的有效媒体
  • 10003指定的多个服务选项 - 目前,只能为我们提供的三种服务中的一个(转录,自动转录,标题)进行订单。该服务由包括Transcription_Options,Automated_Transcription_Options或Caption_Options元素指定。如果请求中包含多个此类元素,则返回此错误。
  • 10004未指定服务类型-必须包含转录选项、automated_transcription_options或caption_options元素中的一个。如果这些都不包含,则返回此错误。
  • 10005指定外部链接和URI -只应该为输入媒体设置外部链接或URI
  • 10006输入位置未指定 - 既不是输入介质的外部链路和URI
  • 10007无法连接到提供的外部链接
  • 20001无效媒体长度-如果其中一个输入媒体具有非正整数的指定音频长度。如果您不提供音频长度,我们也无法自动计算它,这也将返回
  • 20010参考编号太长代码-提供的参考编号超过256个字符
  • 30010不符合余额支付条件-如果代表其发出订单请求的用户不符合使用帐户余额支付的条件
  • 30011帐户余额限制超过-如果订单请求使用帐户余额指定付款,但这样做将超过用户的余额限制
  • 40010 PO编号太长 - 提供的PO,项目或提供的部门超过最大长度
  • 40011用户未授权的PO号码-用户没有发票设置或不能在付款时设置PO
  • 40012 PO编号的无效订单类型 - PO,项目或部门提供不受支持的订单类型
  • 50000个字段验证错误 - 一个或多个字段格式错误
带注释的示例请求
{/ *可选,对于客户端* /“client_ref”的订单的参考编号:“xb432423”,/ *强制性,提供有关需要转录的信息的信息,并允许设置任何自动转录选项。* /“automated_transcription_options”:{/ *强制性,包含要转录的媒体列表。必须具有至少一个元素* /“输入”:[{/ *音频长度,以秒为单位。* /“Audio_length_seconds”:60,/ *媒体URI,从呼叫返回到发布/输入* /,“URI”:“URN:Rev:InputMedia:467432FDS”},{/ * YouTube URL,音频长度自动确定。* /“External_Link”:“http://www.youtube.com/watch?v=uf8ur6z6klc”},{/ *对于任何其他外部链接URL音频长度是必需的* /“audio_length_seconds”:300,“External_Link”:“https://vimeo.com/7976699”}“,/ *可选,可以接收有关订单状态* /”通知“的通知:{/ *通知的URL。如果使用了notifications元素,则为必选。更新将发布到此URL * /“URL”:“http://www.clientsite.com/orlesupdate”,/ *可选,指定发送的通知。如果是“详细的”,那么当订单处于新状态或有新评论时,就会发送通知。 If "FinalOnly" (the default), notification is sent only when the order is complete. */ "level": "Detailed" }, /* Optional- customer must have invoicing, it links order to PO, Project, or Department for billing */ "ponumber": "SamplePoNumber01" }
< order_request > < !——可选,对客户端有意义的订单引用号——> XB432423  < automated_transcription_options > < !-强制性,包含要转录的媒体列表。必须至少有一个元素——>    < audio_length_seconds > 600 < / audio_length_seconds > < !——必选,媒体的URI,从POST /inputs调用返回——> < URI >urn:rev:inputmedia:467432fds    http://www.youtube.com/watch?v=UF8uR6Z6KLc    300 https://vimeo.com/7976699       http://www.clientsite.com/orderupdate  Detailed   SamplePoNumber01