Protocol service debug list groups

POST /protocol/v1/DebugListGroups

Body Required

object object

Responses

  • 200

    A successful response.(streaming responses)

    Hide response attributes Show response attributes object
    • result object
      Hide result attributes Show result attributes object
      • group_pk string(byte)
      • group_type string
        • GroupTypeUndefined: GroupTypeUndefined indicates that the value has not been set. Should not happen.
        • GroupTypeAccount: GroupTypeAccount is the group managing an account, available to all its devices.
        • GroupTypeContact: GroupTypeContact is the group created between two accounts, available to all their devices.
        • GroupTypeMultiMember: GroupTypeMultiMember is a group containing an undefined number of members.

        Values are GroupTypeUndefined, GroupTypeAccount, GroupTypeContact, or GroupTypeMultiMember. Default value is GroupTypeUndefined.

      • contact_pk string(byte)
    • error object
      Hide error attributes Show error attributes object
      • grpc_code integer(int32)
      • http_code integer(int32)
      • message string
      • http_status string
      • details array[object]
        Hide details attributes Show details attributes array[object]
        • type_url string
        • value string(byte)
  • default

    An unexpected error response

    Hide response attributes Show response attributes object
    • error string
    • code integer(int32)
    • message string
    • details array[object]
      Hide details attributes Show details attributes array[object]
      • type_url string
      • value string(byte)
POST /protocol/v1/DebugListGroups
curl \
 -X POST http://api.example.com/protocol/v1/DebugListGroups
Request example
{}
Request examples
{}
Response examples (200)
{
  "result": {
    "group_pk": "string",
    "group_type": "GroupTypeUndefined",
    "contact_pk": "string"
  },
  "error": {
    "grpc_code": 42,
    "http_code": 42,
    "message": "string",
    "http_status": "string",
    "details": [
      {
        "type_url": "string",
        "value": "string"
      }
    ]
  }
}
Response examples (200)
{
  "result": {
    "group_pk": "string",
    "group_type": "GroupTypeUndefined",
    "contact_pk": "string"
  },
  "error": {
    "grpc_code": 42,
    "http_code": 42,
    "message": "string",
    "http_status": "string",
    "details": [
      {
        "type_url": "string",
        "value": "string"
      }
    ]
  }
}
Response examples (default)
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}
Response examples (default)
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}