AWS End User Messaging Social
Amazon Web Services End User Messaging Social , also referred to as Social messaging, is a messaging service that enables application developers to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services End User Messaging Social , also referred to as Social messaging, is a messaging service that enables
application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the
Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.
The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.
If you're new to the Amazon Web Services End User Messaging Social API , it's also helpful to review What is
Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide . The
Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use
Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications.
The guide also provides key information, such as integration with other Amazon Web Services
services, and the quotas that apply to use of the service.
Regional availability
The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of
all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see
Managing
Amazon Web Services Regions in the Amazon Web Services General
Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These
Availability Zones are physically isolated from each other, but are united by private,
low-latency, high-throughput, and highly redundant network connections. These Availability
Zones enable us to provide very high levels of availability and redundancy, while also
minimizing latency. To learn more about the number of Availability Zones that are available
in each Region, see Amazon Web Services Global Infrastructure.
Endpoints 38
Linked whats app business account
- POSTAssociate whats app business account
/v1/whatsapp/signupThis is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account. - POSTCreate whats app dataset
/v1/whatsapp/waba/datasetCreates a Meta Conversions API dataset for a WhatsApp Business Account. - POSTCreate whats app flow
/v1/whatsapp/flow/createCreates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The… - POSTCreate whats app message template
/v1/whatsapp/template/putCreates a new WhatsApp message template from a custom definition. Amazon Web Services End User Messaging Social does not store any WhatsApp message template… - POSTCreate whats app message template from library
/v1/whatsapp/template/createCreates a new WhatsApp message template using a template from Meta's template library. - POSTCreate whats app message template media
/v1/whatsapp/template/mediaUploads media for use in a WhatsApp message template. - GETGet whats app flow
/v1/whatsapp/flow?id=string&flowId=stringRetrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status. - DELETEDelete whats app flow
/v1/whatsapp/flow?id=string&flowId=stringDeletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted. - GETGet whats app message template
/v1/whatsapp/template?metaTemplateId=string&id=string&templateName=string&templateLanguageCode=stringRetrieves a specific WhatsApp message template. - POSTUpdate whats app message template
/v1/whatsapp/templateUpdates an existing WhatsApp message template. - DELETEDelete whats app message template
/v1/whatsapp/template?metaTemplateId=string&deleteAllTemplates=true&id=string&templateName=stringDeletes a WhatsApp message template. - POSTDeprecate whats app flow
/v1/whatsapp/flow/deprecateDeprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation. - DELETEDisassociate whats app business account
/v1/whatsapp/waba/disassociate?id=stringDisassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account. - GETGet linked whats app business account
/v1/whatsapp/waba/details?id=stringGet the details of your linked WhatsApp Business Account. - GETGet whats app flow preview
/v1/whatsapp/flow/preview?id=string&flowId=string&invalidate=trueGenerates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review. - GETList linked whats app business accounts
/v1/whatsapp/waba/list?nextToken=string&maxResults=0List all WhatsApp Business Accounts linked to your Amazon Web Services account. - GETList whats app flow assets
/v1/whatsapp/flow/assets?id=string&flowId=string&nextToken=string&maxResults=0Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period. - GETList whats app flows
/v1/whatsapp/flow/list?id=string&nextToken=string&maxResults=0Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories. - GETList whats app message templates
/v1/whatsapp/template/list?id=string&nextToken=string&maxResults=0Lists WhatsApp message templates for a specific WhatsApp Business Account. - POSTList whats app template library
/v1/whatsapp/template/library?id=stringLists templates available in Meta's template library for WhatsApp messaging. - POSTPublish whats app flow
/v1/whatsapp/flow/publishPublishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's… - PUTPut whats app business account event destinations
/v1/whatsapp/waba/eventdestinationsAdd an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All… - POSTSend whats app conversion event
/v1/whatsapp/waba/dataset/eventsSends a conversion event to Meta's Conversions API for the specified WhatsApp Business Account dataset. - POSTUpdate whats app flow
/v1/whatsapp/flow/updateUpdates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update… - POSTUpdate whats app flow assets
/v1/whatsapp/flow/assets/updateUpdates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.
Linked whats app phone number
- POSTPost whats app message media
/v1/whatsapp/mediaUpload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using… - DELETEDelete whats app message media
/v1/whatsapp/media?mediaId=string&originationPhoneNumberId=stringDelete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too. - GETGet linked whats app business account phone number
/v1/whatsapp/waba/phone/details?id=stringRetrieve the WABA account id and phone number details of a WhatsApp business account phone number. - GETGet whats app business public key
/v1/whatsapp/business-public-key?originationPhoneNumberId=stringRetrieves the business public key for a phone number and its signature status. - PUTPut whats app business public key
/v1/whatsapp/business-public-keySets the business public key used to encrypt the data exchanged with the endpoint of a data exchange Flow. - POSTGet whats app call permission
/v1/whatsapp/call/permission/getRetrieves the current calling permission for a WhatsApp end user, along with the calling actions the business is allowed to take with that user. Provide the… - POSTGet whats app message media
/v1/whatsapp/media/getGet a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use… - POSTSend whats app call event
/v1/whatsapp/call/eventSends a WhatsApp calling event, such as connecting or terminating a call, for a business phone number. This operation passes the event through to Meta. To use… - POSTSend whats app message
/v1/whatsapp/sendSend a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User… - PUTUpdate linked whats app business account phone number
/v1/whatsapp/waba/phone?id=stringUpdates the calling settings for a linked WhatsApp business phone number, such as whether calling is enabled and the hours during which the business accepts…
- GETList tags for resource
/v1/tags/list?resourceArn=stringList all tags associated with a resource, such as a phone number or WABA. - POSTTag resource
/v1/tags/tag-resourceAdds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. - POSTUntag resource
/v1/tags/untag-resourceRemoves the specified tags from a resource.
API details
- Base URL
https://social-messaging.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 38 operations on 33 pathsPOST 20GET 11DELETE 4PUT 3
- Main resources
- Linked whats app business account 25Linked whats app phone number 10
- Description format
- AWS Smithy model, API version
2024-01-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS End User Messaging Social in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS End User Messaging Social collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate whats app business account” (POST /v1/whatsapp/signup), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS End User Messaging Social?
Amazon Web Services End User Messaging Social , also referred to as Social messaging, is a messaging service that enables application developers to… It is listed under Communication and has 38 endpoints.
Who publishes the AWS End User Messaging Social?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS End User Messaging Social?
Requests go to https://social-messaging.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS End User Messaging Social?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS End User Messaging Social have?
38 operations on 33 paths (20 POST, 11 GET, 4 DELETE, 3 PUT). The largest groups are Linked whats app business account, Linked whats app phone number.
Is forking the AWS End User Messaging Social free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.