Messagebird · Schema

VoiceMessage

Properties

Name Type Description
id string The unique identifier of the voice message.
href string The URL of the voice message resource.
body string The text content of the voice message.
originator string The caller ID displayed to the recipient.
reference string The client reference for the voice message.
language string The language used for text-to-speech.
voice string The voice gender used for text-to-speech.
repeat integer The number of times the message is repeated.
ifMachine string The behavior when an answering machine is detected.
scheduledDatetime string The scheduled date and time for the message.
createdDatetime string The date and time when the voice message was created.
recipients object
View JSON Schema on GitHub

JSON Schema

messagebird-voicemessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoiceMessage",
  "title": "VoiceMessage",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the voice message."
    },
    "href": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the voice message resource."
    },
    "body": {
      "type": "string",
      "description": "The text content of the voice message."
    },
    "originator": {
      "type": "string",
      "description": "The caller ID displayed to the recipient."
    },
    "reference": {
      "type": "string",
      "description": "The client reference for the voice message."
    },
    "language": {
      "type": "string",
      "description": "The language used for text-to-speech."
    },
    "voice": {
      "type": "string",
      "description": "The voice gender used for text-to-speech."
    },
    "repeat": {
      "type": "integer",
      "description": "The number of times the message is repeated."
    },
    "ifMachine": {
      "type": "string",
      "description": "The behavior when an answering machine is detected."
    },
    "scheduledDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The scheduled date and time for the message."
    },
    "createdDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the voice message was created."
    },
    "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 delivery."
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "recipient": {
                "type": "integer",
                "format": "int64",
                "description": "The recipient phone number."
              },
              "status": {
                "type": "string",
                "description": "The delivery status."
              },
              "statusDatetime": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time of the last status update."
              }
            }
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/messagebird-voicemessage"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.