Control

Out-of-band control messages for the connect protocol. Blocking request-response control messages need to be handled out-of-band to resolve the possibility of dedlocks in the client sequence.

POSThttps://api.bringyour.com/connect/control

Authorization

BearerAuth

Body

application/json

packarray of string

base64 encoded connect protobuf Pack processed as control messages. As an inline message, these would be sent to the control id.

Response

200

Body

application/json

packarray of string

base64 encoded connect Pack resulting from processing the control messages. As an inline message, this is what would be sent from the control id after processing the control messages.

errorobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.bringyour.com/connect/control', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "pack": [
    "text"
  ],
  "error": {
    "message": "text"
  }
}