open-im-server/cmd/openim-api/docs/swagger.yaml

basePath: /
definitions:
  apiresp.ApiResponse:
    properties:
      data: {}
      errCode:
        type: integer
      errDlt:
        type: string
      errMsg:
        type: string
    type: object
  auth.UserTokenReq:
    properties:
      platformID:
        type: integer
      secret:
        type: string
      userID:
        type: string
    type: object
  auth.UserTokenResp:
    properties:
      expireTimeSeconds:
        type: integer
      token:
        type: string
    type: object
  msggateway.GetUsersOnlineStatusReq:
    properties:
      userIDs:
        items:
          type: string
        type: array
    type: object
  msggateway.GetUsersOnlineStatusResp_SuccessDetail:
    properties:
      connID:
        type: string
      isBackground:
        type: boolean
      platform:
        type: string
      status:
        type: string
      token:
        type: string
    type: object
  msggateway.GetUsersOnlineStatusResp_SuccessResult:
    properties:
      detailPlatformStatus:
        items:
          $ref: '#/definitions/msggateway.GetUsersOnlineStatusResp_SuccessDetail'
        type: array
      status:
        type: string
      userID:
        type: string
    type: object
  sdkws.UserInfo:
    properties:
      appMangerLevel:
        type: integer
      createTime:
        type: integer
      ex:
        type: string
      faceURL:
        type: string
      globalRecvMsgOpt:
        type: integer
      nickname:
        type: string
      userID:
        type: string
    type: object
  user.GetDesignateUsersReq:
    properties:
      userIDs:
        items:
          type: string
        type: array
    type: object
  user.GetDesignateUsersResp:
    properties:
      usersInfo:
        items:
          $ref: '#/definitions/sdkws.UserInfo'
        type: array
    type: object
  user.SetGlobalRecvMessageOptReq:
    properties:
      globalRecvMsgOpt:
        type: integer
      userID:
        type: string
    type: object
  user.SetGlobalRecvMessageOptResp:
    type: object
  user.UpdateUserInfoReq:
    properties:
      userInfo:
        $ref: '#/definitions/sdkws.UserInfo'
    type: object
  user.UpdateUserInfoResp:
    type: object
  user.UserRegisterReq:
    properties:
      secret:
        type: string
      users:
        items:
          $ref: '#/definitions/sdkws.UserInfo'
        type: array
    type: object
  user.UserRegisterResp:
    type: object
host: localhost:10002
info:
  contact: {}
  description: Open-IM-Server API server document, all requests in the document have
    an OperationId field for link tracking
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: open-IM-Server API
  version: "1.0"
paths:
  /auth/user_token:
    post:
      consumes:
      - application/json
      description: Get the user token
      operationId: UserToken
      parameters:
      - description: OperationId
        in: header
        name: OperationId
        required: true
        type: string
      - description: Secret is the Openim key. For details, see the server Config.yaml
          Secret field <br> Platform is the platform ID
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/auth.UserTokenReq'
      produces:
      - application/json
      responses:
        "0":
          description: ""
          schema:
            $ref: '#/definitions/auth.UserTokenResp'
        "400":
          description: Errcode is 400, which is generally a parameter input error.
          schema: {}
        "500":
          description: ERRCODE is 500 generally an internal error of the server
          schema: {}
      summary: User login
      tags:
      - Authentication
  /user/get_users_info:
    post:
      consumes:
      - application/json
      description: Obtain user information in batches according to the user list
      operationId: GetUsersInfo
      parameters:
      - description: Operation Id
        in: header
        name: OperationId
        required: true
        type: string
      - description: Request
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/user.GetDesignateUsersReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/user.GetDesignateUsersResp'
        "400":
          description: errcode is 400 一Input errors in the parameter, token is not
            brought up
          schema: {}
        "500":
          description: Errcode is 500 一For the internal error of the server
          schema: {}
      security:
      - ApiKeyAuth: []
      summary: Get user information
      tags:
      - User
  /user/get_users_online_status:
    post:
      consumes:
      - application/json
      description: Get user online status
      operationId: GetUsersOnlineStatus
      parameters:
      - description: Operation Id
        in: header
        name: OperationId
        required: true
        type: string
      - description: Request
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/msggateway.GetUsersOnlineStatusReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/apiresp.ApiResponse'
            - properties:
                data:
                  items:
                    $ref: '#/definitions/msggateway.GetUsersOnlineStatusResp_SuccessResult'
                  type: array
              type: object
        "400":
          description: Errcode is 400, which is generally a parameter input error.
          schema: {}
        "500":
          description: ERRCODE is 500 generally an internal error of the server
          schema: {}
      security:
      - ApiKeyAuth: []
      summary: Get user online status
      tags:
      - User
  /user/set_global_msg_recv_opt:
    post:
      consumes:
      - application/json
      description: Set the overall disturbance
      operationId: SetGlobalRecvMessageOpt
      parameters:
      - description: Operation Id
        in: header
        name: OperationId
        required: true
        type: string
      - description: GlobalRecvmsGopt is the global disturbance setting 0 to turn
          off 1 to open
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/user.SetGlobalRecvMessageOptReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/user.SetGlobalRecvMessageOptResp'
        "400":
          description: Errcode is 400, which is generally a parameter input error.
          schema: {}
        "500":
          description: ERRCODE is 500 generally an internal error of the server
          schema: {}
      security:
      - ApiKeyAuth: []
      summary: Set the overall disturbance
      tags:
      - User
  /user/update_user_info:
    post:
      consumes:
      - application/json
      description: Modify user information Userid Faceurl, etc.
      operationId: UpdateUserInfo
      parameters:
      - description: Operation Id
        in: header
        name: OperationId
        required: true
        type: string
      - description: Request
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/user.UpdateUserInfoReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/user.UpdateUserInfoResp'
        "400":
          description: Errcode is 400, which is generally a parameter input error.
          schema: {}
        "500":
          description: ERRCODE is 500 generally an internal error of the server
          schema: {}
      security:
      - ApiKeyAuth: []
      summary: Modify user information
      tags:
      - User
  /user/user_register:
    post:
      consumes:
      - application/json
      description: User registration
      operationId: UserRegister
      parameters:
      - description: Operation Id
        in: header
        name: OperationId
        required: true
        type: string
      - description: Secret is the Openim key. For details, see the server Config.yaml
          Secret field.
        in: body
        name: UserInfo
        required: true
        schema:
          $ref: '#/definitions/user.UserRegisterReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/user.UserRegisterResp'
        "400":
          description: Errcode is 400, which is generally a parameter input error.
          schema: {}
        "500":
          description: ERRCODE is 500 generally an internal error of the server
          schema: {}
      summary: User registration
      tags:
      - User
schemes:
- http
- https
securityDefinitions:
  ApiKeyAuth:
    description: Description for what is this security definition being used
    in: header
    name: token
    type: apiKey
swagger: "2.0"