messagebird · Schema

Recipients

Properties

Name Type Description
totalCount integer The total number of recipients.
totalSentCount integer The number of messages sent.
totalDeliveredCount integer The number of messages delivered.
totalDeliveryFailedCount integer The number of messages that failed to deliver.
items array The list of recipient details.
View JSON Schema on GitHub

JSON Schema

messagebird-recipients-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Recipients",
  "title": "Recipients",
  "type": "object",
  "properties": {
    "totalCount": {
      "type": "integer",
      "description": "The total number of recipients."
    },
    "totalSentCount": {
      "type": "integer",
      "description": "The number of messages sent."
    },
    "totalDeliveredCount": {
      "type": "integer",
      "description": "The number of messages delivered."
    },
    "totalDeliveryFailedCount": {
      "type": "integer",
      "description": "The number of messages that failed to deliver."
    },
    "items": {
      "type": "array",
      "description": "The list of recipient details.",
      "items": {
        "$ref": "#/components/schemas/Recipient"
      }
    }
  }
}