接口文档SDK业务专题开发者工具

通用参数

本节将为您介绍 Marketing API 中每个接口必备的请求通用参数以及响应数据结构。

特别注意,由于本章节已经介绍通用参数的用法,之后各接口的描述部分将不再赘述。


请求通用参数

请求中的通用参数详细定义如下表所示:

名称 类型 必填 限制 描述
access_token string 以Query Parameter方式在请求路径中传递。 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节。
timestamp timestamp 以Query Parameter方式在请求路径中传递。 当前的时间戳,单位为秒,允许客户端请求最大时间误差为300秒。

  • MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳
  • MarketingAPI 所使用的时区为GMT+8,例如当时间戳为1494840119时,表示 2017-05-15 17:21:59
nonce string 以Query Parameter方式在请求路径中传递。 随机字串标识,不超过32个字符,由调用方自行生成,需保证全局唯一性。

响应数据结构

响应数据中的结构定义如下表所示:

名称 类型 是否一定返回 限制 描述
code int64 等于0表示成功,不等于0表示错误,具体见文档附录【返回码定义】 返回码
message string code不等于0时,message为错误描述 错误描述
data object 具体返回内容见各接口定义,只在code等于0时可能返回 资源数据
errors object 只在code不等于0时可能返回 详细错误信息