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

POST /protocol/v1/GroupMetadataSubscribe

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)
  
  metadata object
  
  Hide metadata attributes Show metadata attributes object
  
  event_type string
  
  Values are EventTypeUndefined, EventTypeGroupMemberDeviceAdded, EventTypeGroupDeviceSecretAdded, EventTypeAccountGroupJoined, EventTypeAccountGroupLeft, EventTypeAccountContactRequestDisabled, EventTypeAccountContactRequestEnabled, EventTypeAccountContactRequestReferenceReset, EventTypeAccountContactRequestOutgoingEnqueued, EventTypeAccountContactRequestOutgoingSent, EventTypeAccountContactRequestIncomingReceived, EventTypeAccountContactRequestIncomingDiscarded, EventTypeAccountContactRequestIncomingAccepted, EventTypeAccountContactBlocked, EventTypeAccountContactUnblocked, EventTypeContactAliasKeyAdded, EventTypeMultiMemberGroupAliasResolverAdded, EventTypeMultiMemberGroupInitialMemberAnnounced, EventTypeMultiMemberGroupAdminRoleGranted, or EventTypeGroupMetadataPayloadSent. Default value is EventTypeUndefined.
  
  payload string(byte)
  
  sig string(byte)
  
  event 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/GroupMetadataSubscribe

curl \
 -X POST http://api.example.com/protocol/v1/GroupMetadataSubscribe \
 -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"
    },
    "metadata": {
      "event_type": "EventTypeUndefined",
      "payload": "string",
      "sig": "string"
    },
    "event": "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"
    },
    "metadata": {
      "event_type": "EventTypeUndefined",
      "payload": "string",
      "sig": "string"
    },
    "event": "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"
    }
  ]
}