微信接口传json格式怎么写

微信接口传JSON格式全指南：从基础到实践

在微信生态开发中,无论是公众号、小程序还是企业微信，接口交互都离不开数据传输，JSON（JavaScript Object Notation）因其轻量、易读、易解析的特性，成为微信接口最常用的数据格式，本文将详细介绍微信接口中JSON格式的规范、常见场景及实践技巧，帮助开发者快速这一核心技能。

微信接口JSON格式的基础规范

微信接口对JSON格式有明确的约定,遵循这些规范是确保数据成功传输的前提。

基本格式要求

JSON是一种键值对（key-value）结构，数据以包裹，键值对用分隔，多个键值对用分隔，值（value）可以是字符串、数字、布尔值、数组、对象或null。

{
  "openid": "oABC123xyz789",
  "nickname": "张三",
  "subscribe_time": 1625097600,
  "tags": ["VIP", "活跃用户"],
  "address": {
    "province": "广东省",
    "city": "深圳市"
  }
}

字符串格式规范

• 必须用双引号：JSON的键和字符串类型的值必须用双引号（）包裹，不能用单引号（）。"openid"正确，'openid'错误。
• 特殊字符转义：字符串中的双引号、反斜线等特殊字符需转义，如"desc": "他说：\"你好\""。
• 编码统一：微信接口要求使用UTF-8编码，避免因编码问题导致乱码。

数据类型匹配

微信接口对字段的数据类型有严格要求,需严格按照文档定义传递：

• 字符串：如openid、nickname，需传双引号包裹的文本。
• 数字：如subscribe_time（时间戳）、total_fee（金额），直接传数字，不加引号。
• 布尔值：如is_subscribe，需传true或false（小写），不能传"true"或"1"。
• 数组：如tags，需用[]包裹，元素间用分隔，如["tag1", "tag2"]。
• 对象：如address，用包裹，嵌套键值对结构。

微信接口中JSON的常见应用场景

接口请求参数（POST/PUT）

调用微信接口时,请求体（Body）通常需传递JSON格式数据。

• 公众号获取用户信息：通过snsapi_userinfo授权后，需传递access_token和openid获取用户详情。
  请求示例（POST Body）：

  {
    "access_token": "ACCESS_TOKEN",
    "openid": "oABC123xyz789",
    "lang": "zh_CN"
  }

• 小程序支付：调用UnifiedOrder接口生成预支付订单，需传递订单详情、商品信息等JSON数据。
  请求示例（简化）：

  {
    "appid": "wxd678efh567hg6787",
    "mch_id": "1234567890",
    "nonce_str": "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
    "body": "腾讯充值中心-QQ会员充值",
    "out_trade_no": "YOUR_ORDER_ID",
    "total_fee": 88,
    "spbill_create_ip": "123.12.12.123",
    "notify_url": "https://www.yourdomain.com/notify",
    "trade_type": "JSAPI"
  }

接口响应数据（Response）

微信接口返回的数据也多为JSON格式,包含状态码、响应数据等字段。

• 获取access_token响应：

  {
    "access_token": "ACCESS_TOKEN",
    "expires_in": 7200,
    "errcode": 0,
    "errmsg": "ok"
  }

• 错误响应：当接口调用失败时，返回JSON格式的错误信息：

  {
    "errcode": 40003,
    "errmsg": "invalid openid"
  }

事件推送数据

微信服务器向开发者服务器推送的事件（如关注/取消关注、支付成功）也是JSON格式。

• 关注事件（subscribe）：

  <xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[FromUser]]></FromUserName>
    <CreateTime>1631234567</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe]]></Event>
    <EventKey><![CDATA[qrscene_123]]></EventKey>
  </xml>

  注：事件推送通常为XML格式，但部分场景（如小程序云开发事件、企业微信回调）会使用JSON，需根据具体接口文档判断。

不同开发语言中JSON的实践方法

JavaScript/Node.js

• 构造JSON对象：直接使用字面量创建，通过JSON.stringify()转换为字符串：

  const requestData = {
    appid: "your_appid",
    secret: "your_secret",
    grant_type: "client_credential"
  };
  const jsonStr = JSON.stringify(requestData);

• 解析JSON响应：使用JSON.parse()：

  const response = '{"access_token":"TOKEN","expires_in":7200}';
  const data = JSON.parse(response);
  console.log(data.access_token);

Python

• 构造JSON：使用json模块的dumps()方法：

  import json
  request_data = {
      "appid": "your_appid",
      "secret": "your_secret",
      "grant_type": "client_credential"
  }
  json_str = json.dumps(request_data, ensure_ascii=False)  # 处理中文

• 解析JSON：使用json.loads()：

  response = '{"access_token":"TOKEN","expires_in":7200}'
  data = json.loads(response)
  print(data["access_token"])

Java

• 构造JSON：使用第三方库（如Gson、Jackson）：

  import com.google.gson.Gson;
  public class Main {
      public static void main(String[] args) {
          RequestData data = new RequestData();
          data.setAppid("your_appid");
          data.setSecret("your_secret");
          data.setGrantType("client_credential");
          Gson gson = new Gson();
          String jsonStr = gson.toJson(data);
          System.out.println(jsonStr);
      }
  }
  class RequestData {
      private String appid;
      private String secret;
      private String grantType;
      // getter/setter省略
  }

• 解析JSON：使用Gson的fromJson()方法：

  ResponseData data = gson.fromJson(responseJson, ResponseData.class);
  System.out.println(data.getAccessToken());

PHP

• 构造JSON：使用json_encode()：

  $requestData = [
      "appid" => "your_appid",
      "secret" => "your_secret",
      "grant_type" => "client_credential"
  ];
  $jsonStr = json_encode($requestData, JSON_UNESCAPED_UNICODE); // 不转义中文

• 解析JSON：使用json_decode()：

  $response = '{"access_token":"TOKEN","expires_in":7200}';
  $data = json_decode($response, true); // 第二个参数true返回数组，false返回对象
  echo $data["access_token"];

常见问题与注意事项

字段名大小写敏感

微信接口的JSON字段名是大小写敏感的,例如access_token不能写成Access_Token或ACCESS_TOKEN，需严格参照接口文档定义。

避免多余逗号

JSON对象或数组的最后一个元素后不能加逗号,否则会解析失败。

// 错误示例
{
  "key1": "value1",
  "key2": "value2",  // 最后一个元素后有多余逗号
}

// 正确示例
{
  "key1": "value1",
  "key2": "value2"
}

数据类型错误

易错点：将数字传成字符串（如"total_fee": "88"应改为88），或将布尔值传