Postman Guide
Go to Postman v1
  • πŸ₯³About Postman v1 (Postman Legacy)
  • Campaign Guide - General
    • πŸš€How to send a campaign?
      • ☝️Before You Start
        • Demo Mode
  • Campaign Guide - Email
    • πŸ“§Email Campaigns - Basics
      • How do I send an email campaign?
      • Scheduled Sending
      • Bounced Emails and Halted Campaigns
      • Email Statistics
      • Formatting your Message Template
      • Variable Fields
      • Unique URL Link per Recipient
      • Pasting Content from Microsoft Word
      • Manage your Unsubscriptions
      • Understanding Unsubscriptions
    • πŸ”Sending Password-Protected Emails
      • Tutorial
      • Template Editor
  • Campaign Guide - SMS
    • πŸ“²SMS Campaigns - Basics
      • Before Starting Out
      • Summary of Costs
    • πŸͺœSMS Onboarding Overview
      • Step 1: Sender ID Registration
      • Step 2: Sign up for a Twilio account
      • Step 3: Set up your Twilio account
      • Step 4: Configure Your Twilio Account
        • What if I need to buy a phone number?
      • Step 5: Send a Test Message on Twilio
      • Step 6: Fill in your Twilio credentials in Postman!
        • How do I send a campaign with my saved SMS credentials?
    • πŸ€”What else do I need to know about sending SMSes?
      • More about Sender ID registration
      • Can I see the send status of my campaign?
      • How can I configure my SMS send rate?
      • Sending an SMS to a Foreign Number
      • SMS Best Practices
      • Useful Twilio Links
  • Campaign Guide - Telegram
    • πŸ€–Telegram Campaigns - Basics
      • How do I set up Telegram to send my campaigns?
      • Add Telegram Bot Token in Postman
      • Instructions for Recipient Onboarding
      • Use the Bot in the Campaign
      • Telegram Formatting
      • Telegram Bot Statistics
  • Email API Guide
    • πŸ“–Overview
      • IM8 Policies
      • Connecting your Intranet Application
      • API Response Formats
    • πŸ—οΈEmail API Key Management
      • Bearer Authentication
      • Generate your email API Key
      • Rotate your email API Key
    • πŸ“¨Programmatic Email API
      • Getting Started
      • Comparison with AMR
      • SG-Mail Whitelisting
      • Custom From Address
      • Tracking Email Status
      • Send Email API
        • From Name and From Address
        • CC and BCC
        • Recipient Blacklist
        • Email Tagging and Classification
        • Email Body
          • Embedding Images
            • Linked Images
            • Content-ID Images
        • Attachments
        • Rate Limit
      • Get Email by ID API
      • List Emails API
    • πŸ“¨Programmatic GovSG WhatsApp API
      • Getting Started
      • Tracking Message Status
      • Get Available Templates API
      • Send Message API
      • Get Message by ID API
      • List Messages API
    • πŸŽ“Frequently Asked Questions
  • FAQ
    • πŸ“ΆService Status
    • For Recipients
      • Check Email Authenticity
    • For Senders
      • Messaging Channel Comparison
      • Cost Breakdown
  • Legal
    • Terms & Conditions
    • Privacy Policy
  • Contact Us
  • GitHub
Powered by GitBook
On this page
  • Gov.sg WhatsApp Message Status
  • Error Codes and Error Description
  • Error code while attempting to send messages
  • Error code after a message has been sent
  • Tracking open rates

Was this helpful?

  1. Email API Guide
  2. Programmatic GovSG WhatsApp API

Tracking Message Status

PreviousGetting StartedNextGet Available Templates API

Last updated 1 year ago

Was this helpful?

API users can track the status of messages sent via our API.

Gov.sg WhatsApp Message Status

You can get the status of each email sent sent using .

We currently do not support pushing webhooks to your server when the status of a message changes.

For a list of statuses supported by our API, please refer to the table below.

Status
Definition

UNSENT

Initial state of a newly created transactional Gov.sg message (this status is not returned in the course of a successful request to send a Gov.sg message)

ACCEPTED

Message has been accepted by our service provider (this status is returned in the course of a successful request to send a Gov.sg message)

SENT

The send request was successfully forwarded to our service provider and our service provider will attempt to deliver the message to the recipient’s phone number (API user can check this and all subsequent statuses via the /transactional/govSG/{messageId} endpoint)

DELIVERED

The service provider has successfully delivered the message to the recipient's phone number

READ

The recipient has received the message and viewed it

ERROR

An error happened when the service provider is trying to deliver the message

Error Codes and Error Description

The error_code and error_description fields in the JSON object returned supplement the email status and provide additional information.

You can find a non-exhaustive list of error codes below.

Error code while attempting to send messages

  • invalid_recipient: This error is returned when the recipient number provided is either not a valid phone number or doesn't have any WhatsApp account associated with it. Under this scenario, no message will be sent out.

Error code after a message has been sent

After Postman platform has successfully forwarded the message request to our provider WhatsApp, all errors that are logged from WhatsApp will be recorded in Postman system with the corresponding error_code and human-readable error_description.

Tracking open rates

A message is recorded as READ when the recipient has opened the thread and blue-ticked the message. Please note that if the recipient configure their WhatsApp to not send read receipt, this won't happen hence the message status will finalise at DELIVERED.

For more details about the possible errors that can happen, please check out .

πŸ“¨
this API endpoint
by our API
this page