yuyin-php/extend/RongCloud/Lib/Group/api.json

{
  "sync": {
    "docs": "http://rongcloud.cn/docs/server.html#group_sync",
    "url": "group/sync",
    "params": {
      "user": {
        "id": "123werm98",
        "groups": [
          {"id": "wer987","name":"greoupName1"},
          {"id":"wer989","name": "greoupName2"}
        ]
      }
    },
    "response": {
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1502": {
          "code": "1502",
          "msg": "{{name}} 数量超限，{{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "create": {
    "docs": "http://rongcloud.cn/docs/server.html#group_create",
    "url": "group/create",
    "params": {
      "group": {
        "id": "10001",
        "name": "TestGroup",
        "members": ["aFo990k","aFo991k"]
      }
    },
    "response": {
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1502": {
          "code": "1502",
          "msg": "{{name}} 数量超限，{{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "invite": {
    "docs": "http://rongcloud.cn/docs/server.html#group_join",
    "url": "group/join",
    "params": {
      "group": {
        "members": ["aFo990k","aFo991k"],
        "id": "10001",
        "name": "TestGroup"
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1502": {
          "code": "1502",
          "msg": "{{name}} 数量超限，{{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}} "
        },
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "join": {
    "docs": "http://rongcloud.cn/docs/server.html#group_join",
    "url": "group/join",
    "params": {
      "group": {
        "member": "aFo990k",
        "id": "10001",
        "name": "TestGroup"
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1502": {
          "code": "1502",
          "msg": "{{name}} 数量超限，{{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}} "
        },
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "quit": {
    "docs": "http://rongcloud.cn/docs/server.html#group_quit",
    "url": "group/quit",
    "params": {
      "group": {
        "id": "10001",
        "members": ["aFo990k"]
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "kick": {
    "docs": "http://rongcloud.cn/docs/server.html#group_quit",
    "url": "group/quit",
    "params": {
      "group": {
        "id": "10001",
        "members": ["aFo990k","aFo991k"]
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "dismiss": {
    "docs": "http://rongcloud.cn/docs/server.html#group_dismiss",
    "url": "group/dismiss",
    "params": {
      "group": {
        "id": "10001"
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "update": {
    "docs": "http://rongcloud.cn/docs/server.html#group_refresh",
    "url": "group/refresh",
    "params": {
      "group": {
        "id":"10001",
        "name": "testGroup1"
      }
    },
    "response":{
      "success": {
        "code": "200",
        "msg": "成功返回"
      },
      "fail": {
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  },
  "get": {
    "docs": "http://rongcloud.cn/docs/server.html#group_user_query",
    "url": "group/user/query",
    "params": {
      "group": {
        "id": "10001"
      }
    },
    "response":{
      "success": {
        "code": "200",
        "members": [{
          "id": "10001"
        }, {
          "id": "10002"
        }, {
          "id": "10000"
        }, {
          "id": "10003"
        }]
      },
      "fail": {
        "1005": {
          "code": "1005",
          "msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
        },
        "1002": {
          "code": "1002",
          "msg": "{{name}} 参数为必传项"
        },
        "1501": {
          "code": "1501",
          "msg": "参数类型不正确，请检查参数类型，应该为 {{type}} 当前为 {{currentType}}"
        },
        "1004": {
          "code": "1004",
          "msg": "签名错误, 请排查 Appkey、Secret 是否正确"
        },
        "1008": {
          "code": "1008",
          "msg": "调用频率超限"
        }
      }
    }
  }
}