搜狗首页  |   服务首页  |   客服热线:010-56898080

WebService介绍  |  响应头信息

响应头信息用来描述一次请求的结果状态,包括成功 / 失败状态、操作时间、配额(已取消配额,可忽略)等相关数据。 API 的所有响应信息中均含有相同格式的响应头。建议您在程序实现时每次调用均把这些数据保存到本地日志文件中。响应头信息中包含的数据如下:

元素名 类型 说明 是否必须
desc String 返回结果描述,值有四个:
success :执行成功
success with failures :部分执行成功,部分执行失败
failure :全部执行失败
system failure :系统认证失败或者系统内部错误。
failures array 错误信息数组,指明了错误原因。具体请见 “ 错误信息 ”
oprs Integer 当前操作执行的操作数
oprtime Integer 当前操作所持续的秒数
quota Integer 当前操作所消耗的配额(可忽略)
rquota Integer 当前操作后剩余配额(可忽略)
status Integer 0- success
1- success with failures
2- failure
3- system failure

上述数据均包含于一个 ResHeader 对象中,如下面例子所示。该响应消息表示的是获取推广组的信息。 ResHeader 中包含了本次操作的系统数据, status 值为 1 表明该次请求发生了错误, quota 值为 3 表明本次请求消耗了 3 个配额, rquota 值为 29998177 表明本次请求完成后尚余 29998177 的配额可用。

<soap:Envelope xmlns:soap=" http://schemas.xmlsoap.org/soap/envelope/ ">
<soap:Header>
<ns3:ResHeader xmlns:ns3=" http://api.sogou.com/sem/common/v1 " xmlns:ns2=" https://api.sogou.com/sem/sms/v1 ">
<ns3:desc>failure</ns3:desc>
<ns3:failures>
<ns3:code>1000012</ns3:code>
<ns3:message> 推广组 Id 不存在 </ns3:message>
<ns3:position>_params.cpcGrpIds[0]</ns3:position>
<ns3:content/>
</ns3:failures>
<ns3:failures>
<ns3:code>1000012</ns3:code>
<ns3:message> 推广组 Id 不存在 </ns3:message>
<ns3:position>_params.cpcGrpIds[2]</ns3:position>
<ns3:content/>
</ns3:failures>
<ns3:failures>
<ns3:code>1000012</ns3:code>
<ns3:message> 推广组 Id 不存在 </ns3:message>
<ns3:position>_params.cpcGrpIds[4]</ns3:position>
<ns3:content/>
</ns3:failures>
<ns3:failures>
<ns3:code>1000012</ns3:code>
<ns3:message> 推广组 Id 不存在 </ns3:message>
<ns3:position>_params.cpcGrpIds[6]</ns3:position>
<ns3:content/>
</ns3:failures>
<ns3:oprs>3</ns3:oprs>
<ns3:oprtime>0</ns3:oprtime>
<ns3:quota>3</ns3:quota>
<ns3:rquota>29998177</ns3:rquota>
<ns3:status>1</ns3:status>
</ns3:ResHeader>
</soap:Header>
<soap:Body>
<ns2:getCpcGrpByCpcGrpIdResponse xmlns:ns2=" https://api.sogou.com/sem/sms/v1 " xmlns:ns3=" http://api.sogou.com/sem/common/v1 ">
<cpcGroupTypes>
<cpcGrpId>22893327</cpcGrpId>
<cpcPlanId>7961</cpcPlanId>
<cpcGrpName>7961_grp_101eCXOaMzVieKMBjQWbiFE</cpcGrpName>
<maxPrice>0.3</maxPrice>
<pause>false</pause>
<status>21</status>
</cpcGroupTypes>
<cpcGroupTypes>
<cpcGrpId>22893329</cpcGrpId>
<cpcPlanId>7961</cpcPlanId>
<cpcGrpName>7961_grp_103TaVAEBVrkiuFecXgFYRi</cpcGrpName>
<maxPrice>0.3</maxPrice>
<pause>false</pause>
<status>21</status>
</cpcGroupTypes>
<cpcGroupTypes>
<cpcGrpId>22893331</cpcGrpId>
<cpcPlanId>7961</cpcPlanId>
<cpcGrpName>7961_grp_105lvIlIXAXqTwHIiOPmvSy</cpcGrpName>
<maxPrice>0.3</maxPrice>
<pause>false</pause>
<status>21</status>
</cpcGroupTypes>
</ns2:getCpcGrpByCpcGrpIdResponse>
</soap:Body>
</soap:Envelope>