View Template Message

Use this API to view template messages added to a WhatsApp Business account.

Endpoint details

FieldValue
URLhttps://apis.rmlconnect.net/wba/templates
Authorizationjwt
API Keyjwt
Header parameter nameAuthorization

What this returns

The response returns the total number of template messages and an array of template message details. Template details can include the template name, id, components, category, status, quality_rating, language, waba_id, and previous_category.

Responses

200 Success

Response

{
  "total": 1,
  "data": [
    {
      "name": "welcome",
      "id": "640099017215xxx",
      "components": [
        {
          "type": "BODY",
          "text": "Hi, Thank you for Opt-ing in to receive notifications from us on WhatsApp. \n\nWe will send you regular updates on our services and promotions. If you wish to unsubscribe, please reply with STOP. \n\nHave a good day."
        }
      ],
      "category": "MARKETING",
      "status": "APPROVED",
      "quality_rating": "UNKNOWN",
      "rejected_reason": "NONE",
      "language": "en",
      "created_date": "21-Feb-2022 04:53 PM",
      "deleted_date": "string",
      "waba_id": "629529078253xxx",
      "previous_category": "ALERT_UPDATE"
    }
  ]
}

Response Schema: application/json

FieldTypeDescription
totalintegerThe total count of items in the response.
dataArray of objectsAn array of objects representing the data or information.
400 Bad Request

Response

{
  "message": "template with name : testing_v160405xx7 and language : ['en_US'] already exists."
}

Response Schema: application/json

FieldTypeDescription
messagestringThe response message.
401 Authentication Failure

Response

{
  "response": "Unauthorized"
}

Response Schema: application/json

FieldTypeDescription
responsestringThe message response.
404 Page Not Found

Response

{
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}

Response Schema: application/json

FieldTypeDescription
messagestringThe message response.
500 Internal Server Error

Response

{
  "status": "failed",
  "message": "unable to process request",
  "reason": "reason"
}

Response Schema: application/json

FieldTypeDescription
statusstringThe status for the message delivery.
messagestringThe message response.
reasonstringThe reason for not processing the request.

Supported template types

Call to Action

Call to Action

Quick Reply

Quick Reply

Media Template

Media Template

Text Template

Text Template

Auth Copycode

Auth Copycode

Auth Autofill

Auth Autofill

Catalog Template

Catalog Template

Copy Code Template

Copy Code Template

Carousel Template

Carousel Template

Limited Time Offer Template

Limited Time Offer Template

Multi Product Message Template

Multi Product Message Template

Payment Order details

Payment Order details

Flow creation

Flow creation



Did this page help you?