Early access WhatsApp messaging: add API reference, spec updates, guides#460
Open
hey-august wants to merge 12 commits into
Open
Early access WhatsApp messaging: add API reference, spec updates, guides#460hey-august wants to merge 12 commits into
hey-august wants to merge 12 commits into
Conversation
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds WhatsApp as a messaging channel in both the REST API reference and the platform guides.
Outbound sends reuse the existing POST
/api/messaging/messagesendpoint. When the from number matches a connected WhatsApp number (identified by its whatsapp: prefix), it gets routed over Whatsapp.message_typeselects a content message, andtemplate_idselects a template.This PR also adds three read/manage surfaces: WhatsApp Business Accounts, WhatsApp numbers, and message templates.
Alpha status
WhatsApp messaging is in alpha / early access. The guides explain this, and include links to the request form for customer Space enablement. The
whatsapp_interactive_flowtype is deliberately omitted because Flows are not part of the alpha program.New pages (with linked previews)
API reference
Guides
File changes
TypeSpec specs
message-api/messages/models/whatsapp.tsp(new): Includes all WhatsApp send models. Has a sharedWhatsAppSendBase, per-type content bodies (image, video, audio, sticker, document, location, contacts, reaction, interactive), themessage_type-discriminatedWhatsAppContentMessageRequestunion, theWhatsAppTemplateMessageRequest, and the combinedSendMessageRequest.message-api/messages/main.tsp: Sends now acceptSendMessageRequest. Endpoint docs explain WhatsApp routing and the 24-hour window.message-api/messages/models/core.tsp: AddswhatsapptoMessageKind, andreadtoMessageStatus.message-api/whatsapp-businesses/(new): Addslist_whatsapp_businessesplus theWhatsAppBusinessmodel and list response.message-api/whatsapp-numbers/(new): Adds list/retrieve for numbers, with theWhatsAppNumbermodel (routing resource IDs, voice-capability flags) and responses.message-api/whatsapp-templates/(new): Adds full CRUD (list/retrieve/create/update/delete), theWhatsAppTemplatemodel, category/format/status enums, and request/response models. Create returns 201, and delete returns 200 with a{ success, errors }body.message-api/tags.tsp: Adds tag metadata for the three new WhatsApp tags.message-api/main.tsp/main.tsp: Wire up the new namespaces and register the tags on the service.Generated reference
fern/apis/signalwire-rest/openapi.yaml: Regenerated from the specs above.Guides (
fern/products/platform/pages/messaging/whatsapp/)overview.mdx: Introduces the alpha, its supported features, how it works, prerequisites, and how to request access.onboarding.mdx: How to connect a Meta-verified business number via embedded signup and verify it through the businesses/numbers endpoints.send-messages.mdx: Routing rules, the fullmessage_typetable, and text / interactive-reply-button / template examples.receive-messages.mdx: Describes inbound handling, message logs, and delivery-status semantics.message-templates.mdx: Components, parameters, categories, and the template lifecycle.Navigation
fern/products/apis/apis.yml: Adds a WhatsApp section referencing the businesses/numbers/templates packages.fern/products/platform/platform.yml: Adds a WhatsApp guide folder under Messaging.Type of Change
Related Issues
#447
Testing
Checklist