Berty Protocol

GroupMessageSubscribe subscribes to a group message updates (types.or it can also retrieve the history)

POST /protocol/v1/GroupMessageSubscribe

Body Required

  • group_pk string(byte)
  • since string(byte)
  • until string(byte)
  • go_backwards boolean(boolean)

Responses

  • 200

    A successful response.(streaming responses)

    Hide response attributes Show response attributes object
    • result object
      Hide result attributes Show result attributes object
      • event_context object
        Hide event_context attributes Show event_context attributes object
        • id string(byte)
        • parent_ids array[string(byte)]
        • group_pk string(byte)
      • headers object
        Hide headers attributes Show headers attributes object
        • counter string(uint64)
        • device_pk string(byte)
        • sig string(byte)
        • metadata object
          Hide metadata attribute Show metadata attribute object
          • Additional properties: string
      • message 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/GroupMessageSubscribe 
curl \
 -X POST http://api.example.com/protocol/v1/GroupMessageSubscribe \
 -d '{"group_pk":"string","since":"string","until":"string","go_backwards":true}'
Request example 
{
  "group_pk": "string",
  "since": "string",
  "until": "string",
  "go_backwards": true
}
Request examples 
{
  "group_pk": "string",
  "since": "string",
  "until": "string",
  "go_backwards": true
}
Response examples (200) 
{
  "result": {
    "event_context": {
      "id": "string",
      "parent_ids": [
        "string"
      ],
      "group_pk": "string"
    },
    "headers": {
      "counter": "string",
      "device_pk": "string",
      "sig": "string",
      "metadata": {}
    },
    "message": "string"
  },
  "error": {
    "grpc_code": 42,
    "http_code": 42,
    "message": "string",
    "http_status": "string",
    "details": [
      {
        "type_url": "string",
        "value": "string"
      }
    ]
  }
}
Response examples (200) 
{
  "result": {
    "event_context": {
      "id": "string",
      "parent_ids": [
        "string"
      ],
      "group_pk": "string"
    },
    "headers": {
      "counter": "string",
      "device_pk": "string",
      "sig": "string",
      "metadata": {
        "Additional properties:": "string"
      }
    },
    "message": "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"
    }
  ]
}