CreateMessageRequest schema from Bandwidth messaging API
Type: objectProperties: 8Required: 4
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA
CreateMessageRequest is a JSON Structure definition published by Bandwidth, describing 8 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/messaging-create-message-request-structure.json",
"name": "CreateMessageRequest",
"description": "CreateMessageRequest schema from Bandwidth messaging API",
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "The Bandwidth phone number to send the message from, in E.164 format",
"example": "+19195551234"
},
"to": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 50,
"description": "Array of destination phone numbers in E.164 format. Up to 50 numbers for group messaging.",
"example": [
"+19195554321"
]
},
"text": {
"type": "string",
"maxLength": 2048,
"description": "The text content of the message. Required for SMS. For MMS, text is optional if media is provided."
},
"media": {
"type": "array",
"items": {
"type": "uri"
},
"description": "Array of media URLs to include as MMS attachments. Each URL must be publicly accessible or a Bandwidth media URL."
},
"applicationId": {
"type": "string",
"description": "The ID of the Bandwidth application associated with this message. This determines which webhook URLs receive delivery callbacks."
},
"tag": {
"type": "string",
"description": "A custom string to attach to the message for tracking purposes"
},
"priority": {
"type": "string",
"enum": [
"default",
"high"
],
"default": "default",
"description": "The priority of the message. High priority messages are delivered faster but may incur additional charges."
},
"expiration": {
"type": "datetime",
"description": "The expiration time for the message. Messages not delivered by this time will be discarded."
}
},
"required": [
"from",
"to",
"text",
"applicationId"
]
}
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.