Telnyx · Schema
WhatsappResponse
CommunicationsCPaaSVoiceSMSIoTTelecommunicationsMessagingArtificial IntelligenceMCPVoice AIPhone NumbersInferenceNumber VerificationPhone VerificationOTP2FALookupVerifyNumber LookupCNAMIdentityFraud Prevention
Properties
| Name | Type | Description |
|---|---|---|
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-whatsapp-response-schema.json",
"title": "WhatsappResponse",
"x-generated": "2026-10-30",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/telnyx-whatsapp-messaging-api-openapi.yml#/components/schemas/WhatsappResponse",
"properties": {
"data": {
"properties": {
"body": {
"$ref": "#/$defs/WhatsappMessageContent"
},
"direction": {
"type": "string"
},
"encoding": {
"type": "string"
},
"from": {
"properties": {
"carrier": {
"description": "The carrier of the sender.",
"type": "string"
},
"line_type": {
"description": "The line-type of the sender.",
"enum": [
"Wireline",
"Wireless",
"VoWiFi",
"VoIP",
"Pre-Paid Wireless",
""
],
"type": "string"
},
"phone_number": {
"description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).",
"type": "string",
"x-format": "address"
},
"status": {
"enum": [
"received",
"delivered"
],
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "message ID",
"type": "string"
},
"messaging_profile_id": {
"type": "string"
},
"organization_id": {
"type": "string"
},
"received_at": {
"format": "date-time",
"type": "string"
},
"record_type": {
"type": "string"
},
"to": {
"$ref": "#/$defs/RCSTo"
},
"type": {
"type": "string"
},
"wait_seconds": {
"description": "Seconds the message is queued due to rate limiting before being sent to the carrier. Represents the maximum wait across all applicable rate limits (account, carrier, campaign). 0.0 = no queuing delay.",
"format": "float",
"type": [
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object",
"$defs": {
"RCSTo": {
"items": {
"$ref": "#/$defs/RCSToItem"
},
"type": "array"
},
"RCSToItem": {
"properties": {
"carrier": {
"type": "string"
},
"line_type": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"WhatsappContact": {
"properties": {
"addresses": {
"items": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"type": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"birthday": {
"type": "string"
},
"emails": {
"items": {
"properties": {
"email": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"org": {
"properties": {
"company": {
"type": "string"
},
"department": {
"type": "string"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"phones": {
"items": {
"properties": {
"phone": {
"type": "string",
"x-format": "E+164"
},
"type": {
"type": "string"
},
"wa_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"urls": {
"items": {
"properties": {
"type": {
"type": "string"
},
"url": {
"format": "url",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"WhatsappInteractive": {
"properties": {
"action": {
"properties": {
"button": {
"type": "string"
},
"buttons": {
"items": {
"properties": {
"reply": {
"properties": {
"id": {
"description": "unique identifier for each button, 256 character maximum",
"type": "string"
},
"title": {
"description": "button label, 20 character maximum",
"type": "string"
}
},
"type": "object"
},
"type": {
"enum": [
"reply"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"cards": {
"items": {
"properties": {
"action": {
"properties": {
"catalog_id": {
"description": "the unique ID of the catalog",
"type": "string"
},
"product_retailer_id": {
"description": "the unique retailer ID of the product",
"type": "string"
}
},
"type": "object"
},
"body": {
"properties": {
"text": {
"description": "160 character maximum, up to 2 line breaks",
"type": "string"
}
},
"type": "object"
},
"card_index": {
"description": "unique index for each card (0-9)",
"type": "integer"
},
"header": {
"properties": {
"image": {
"$ref": "#/$defs/WhatsappMedia"
},
"type": {
"enum": [
"image",
"video"
],
"type": "string"
},
"video": {
"$ref": "#/$defs/WhatsappMedia"
}
},
"type": "object"
},
"type": {
"enum": [
"cta_url"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"catalog_id": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"properties": {
"display_text": {
"description": "button label text, 20 character maximum",
"type": "string"
},
"url": {
"description": "button URL to load when tapped by the user",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"product_retailer_id": {
"type": "string"
},
"sections": {
"items": {
"properties": {
"product_items": {
"items": {
"properties": {
"product_retailer_id": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"rows": {
"items": {
"properties": {
"description": {
"description": "row description, 72 character maximum",
"type": "string"
},
"id": {
"description": "arbitrary string identifying the row, 200 character maximum",
"type": "string"
},
"title": {
"description": "row title, 24 character maximum",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"title": {
"description": "section title, 24 character maximum",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"body": {
"properties": {
"text": {
"description": "body text, 1024 character maximum",
"type": "string"
}
},
"type": "object"
},
"footer": {
"properties": {
"text": {
"description": "footer text, 60 character maximum",
"type": "string"
}
},
"type": "object"
},
"header": {
"properties": {
"document": {
"$ref": "#/$defs/WhatsappMedia"
},
"image": {
"$ref": "#/$defs/WhatsappMedia"
},
"sub_text": {
"type": "string"
},
"text": {
"description": "header text, 60 character maximum",
"type": "string"
},
"video": {
"$ref": "#/$defs/WhatsappMedia"
}
},
"type": "object"
},
"type": {
"enum": [
"cta_url",
"list",
"carousel",
"button",
"location_request_message"
],
"type": "string"
}
},
"type": "object"
},
"WhatsappLocation": {
"properties": {
"address": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"WhatsappMedia": {
"properties": {
"caption": {
"description": "media caption",
"type": "string"
},
"filename": {
"description": "file name with extension",
"type": "string"
},
"link": {
"description": "media URL",
"format": "url",
"type": "string"
},
"voice": {
"description": "true if voice message",
"type": "boolean"
}
},
"type": "object"
},
"WhatsappMessageContent": {
"properties": {
"audio": {
"$ref": "#/$defs/WhatsappMedia"
},
"biz_opaque_callback_data": {
"description": "custom data to return with status update",
"type": "string"
},
"contacts": {
"items": {
"$ref": "#/$defs/WhatsappContact"
},
"type": "array"
},
"document": {
"$ref": "#/$defs/WhatsappMedia"
},
"image": {
"$ref": "#/$defs/WhatsappMedia"
},
"interactive": {
"$ref": "#/$defs/WhatsappInteractive"
},
"location": {
"$ref": "#/$defs/WhatsappLocation"
},
"reaction": {
"$ref": "#/$defs/WhatsappReaction"
},
"sticker": {
"$ref": "#/$defs/WhatsappMedia"
},
"template": {
"description": "Template message object. Provide either template_id or name + language to identify the template.",
"properties": {
"components": {
"description": "Template parameter values for header, body, and button components.",
"items": {
"properties": {
"index": {
"description": "Button index (required for button components)",
"type": "integer"
},
"parameters": {
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"text",
"image",
"video",
"document",
"currency",
"date_time"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"sub_type": {
"enum": [
"quick_reply",
"url"
],
"type": "string"
},
"type": {
"enum": [
"header",
"body",
"button"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"language": {
"description": "Template language. Required unless template_id is provided.",
"properties": {
"code": {
"description": "Language code (e.g. en_US)",
"type": "string"
},
"policy": {
"type": "string"
}
},
"required": [
"code"
],
"type": "object"
},
"name": {
"description": "Template name as registered with Meta. Required unless template_id is provided.",
"type": "string"
},
"template_id": {
"description": "Telnyx template ID (the id field from template list/get responses). When provided, name and language are resolved automatically.",
"type": "string"
}
},
"type": "object"
},
"text": {
"description": "Text message content. Can only be sent within a 24-hour customer service window.",
"properties": {
"body": {
"description": "The text message body.",
"type": "string"
},
"preview_url": {
"default": false,
"description": "Whether to show a URL preview in the message.",
"type": "boolean"
}
},
"required": [
"body"
],
"type": "object"
},
"type": {
"enum": [
"audio",
"document",
"image",
"sticker",
"video",
"interactive",
"location",
"template",
"reaction",
"contacts",
"text"
],
"type": "string"
},
"video": {
"$ref": "#/$defs/WhatsappMedia"
}
},
"type": "object"
},
"WhatsappReaction": {
"properties": {
"emoji": {
"type": "string"
},
"message_id": {
"type": "string"
}
},
"type": "object"
}
}
}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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/telnyx-whatsapp-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.