Messages

Web API endpoints for device messaging.

manage_sessions

Introduced in version 77

Summary: POST /v1/brand/<brand_account_id>/messages/sessions

Create or remove a messaging session for the authenticated account.

manage_sessions changelog

• Version 77: Add messaging session management endpoint.

Request JSON Schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "action": {
          "enum": [
            "create"
          ],
          "type": "string"
        }
      },
      "required": [
        "action"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "action": {
          "enum": [
            "remove"
          ],
          "type": "string"
        },
        "session": {
          "type": "string"
        }
      },
      "required": [
        "action",
        "session"
      ],
      "type": "object"
    }
  ]
}

Response JSON Schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "session": {
          "type": "string"
        }
      },
      "required": [
        "session"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "type": "object"
    }
  ]
}

list_sessions

Introduced in version 77

Summary: GET /v1/brand/<brand_account_id>/messages/sessions

List messaging sessions for the authenticated account.

list_sessions changelog

• Version 77: Add messaging session listing endpoint.

Response JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "sessions": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "session": {
            "type": "string"
          }
        },
        "required": [
          "session"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "sessions"
  ],
  "type": "object"
}

exchange_messages

Introduced in version 77

Summary: POST /v1/brand/<brand_account_id>/messages/sessions/<session_id>/exchange

Exchange messages with devices over a messaging session.

exchange_messages changelog

• Version 77: Add message exchange endpoint.

Request JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "after": {
      "type": "string"
    },
    "limit": {
      "minimum": 0,
      "type": "integer"
    },
    "messages": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "data": {
            "type": "string"
          },
          "format": {
            "enum": [
              "assertion"
            ],
            "type": "string"
          }
        },
        "required": [
          "format",
          "data"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "limit"
  ],
  "type": "object"
}

Response JSON Schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "messages": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "data": {
                "type": "string"
              },
              "format": {
                "enum": [
                  "assertion"
                ],
                "type": "string"
              },
              "token": {
                "type": "string"
              }
            },
            "required": [
              "format",
              "data",
              "token"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "total-pending-messages": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "messages",
        "total-pending-messages"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "total-pending-messages": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "total-pending-messages"
      ],
      "type": "object"
    }
  ]
}