Send Message API
Updated 25 October 2023 We have stopped onboarding new agencies to the Gov.sg WhatsApp channel
Overview
This endpoints accept a request body that contains information about the Gov.sg WhatsApp message to be sent. Each successful request to this endpoint will send out a single Gov.sg WhatsApp message.
Request Body
recipient
: Mobile phone number of the recipient without special formatting (only contains numerical characters and prefixed with plus sign if country code is included).Notes:
Country code will need to be provided for non-SG mobile numbers.
If country code is not provided, the phone number will be defaulted to be an SG number.
template_id
: ID of the template that suits your need (can be retrieved from GET templates endpoint)params
: A key-value object with keys being the parameter names (wrapped in double curly braces in the template body) and corresponding string values to fill in the template body.language_code
(optional): The language code that can be retrieved from themultilingual_support
field of the template
API Response
For general information about our API response formats, see here.
Example Response
{
"id": "505",
"recipient": "+6581489408",
"template_id": "1",
"params": {
"topic": "document collection",
"agency": "Open Government Products",
"timeslot": "1-3PM",
"officer_name": "John Tan",
"recipient_name": "Stanley Nguyen",
"officer_designation": "Reception Officer"
},
"language_code": "en_GB",
"created_at": "2023-07-31T16:39:59.631Z",
"updated_at": "2023-07-31T16:40:01.526Z",
"accepted_at": "2023-07-31T16:40:01.526Z",
"sent_at": null,
"delivered_at": null,
"read_at": null,
"errored_at": null,
"error_code": null,
"error_description": null,
"status": "ACCEPTED"
}
Last updated
Was this helpful?