Send Template and Session Messages API

Use this API to send WhatsApp template messages and session messages to customers.

Endpoint details

Field	Value
URL	https://apis.rmlconnect.net/wba/v1/messages
Authorization	jwt
API Key	jwt
Header parameter name	Authorization
Request Body schema	application/json

Supported message types

The API supports both template messages and session messages. Expand the dropdowns below to review the supported message types, then use the matching request sample later on this page.

Template message types

Text

Text with Text Header

Media Image

Media Document

Media Video

Auth Copycode

Auth Autofill

Quick Reply With ID

Carousel

Copy Code

Catalog Thumbnail

Multi Product Template Messages

Limited Time Offer

Payment template messages

Flow Template Messages

Session message types

Session Text

Session Text Reply To

Send Text with Preview URL

Session Document

Session Audio

Session Image

Session Video

Session Location

Interactive List

Session Quick Reply with Media

Session Quick Reply with Text

Session Single Product

Session Multi Product

Flow Message

Payment Message with catalog ID

Payment Message Without Catalog ID

Payment Message with Payu Gateway

Payment Message with Razorpay Gateway

Payment Message with UPI

Payment Message with Payment Link

Payment Order Status

1). a). Send message template - Text

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "media_template",
    "template_name": "{your template}",
    "lang_code": "{lang_code}",
    "body": [
      {
        "text": "{variable}"
      },
      {
        "text": "{variable}"
      }
    ],
    "button": [
      {
        "button_no": "0/1",
        "url": "{dynamic_url variable}"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
extra (string) — Additional information to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the message to be sent.

b). Text with Text Header:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "media_template",
    "lang_code": "{code}",
    "template_name": "{your template}",
    "header": [
      {
        "text": "{variable}"
      }
    ],
    "body": [
      {
        "text": "{variable}"
      },
      {
        "text": "{variable}"
      }
    ],
    "button": [
      {
        "button_no": "0/1",
        "url": "{dynamic_url variable}"
      }
    ]
  }
}

c). Media Image:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "media_template",
    "lang_code": "{code}",
    "template_name": "{your template}",
    "header": [
      {
        "image": {
          "link": "{sample image url hosted publicly starting with https:// and ending with file extension}",
          "file_name": "{sample media name and ending with file extension}"
        }
      }
    ],
    "body": [
      {
        "text": "{variable}"
      },
      {
        "text": "{variable}"
      }
    ],
    "button": [
      {
        "button_no": "0/1",
        "url": "{dynamic_url variable}"
      }
    ]
  }
}

d). Media Document:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "media_template",
    "lang_code": "{code}",
    "template_name": "{your template}",
    "header": [
      {
        "document": {
          "link": "{sample document url hosted publicly starting with https:// and ending with file extension}",
          "file_name": "{sample media name and ending with file extension}"
        }
      }
    ],
    "body": [
      {
        "text": "{variable}"
      },
      {
        "text": "{variable}"
      }
    ],
    "button": [
      {
        "button_no": "0/1",
        "url": "{dynamic_url variable}"
      }
    ]
  }
}

e). Media Video:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "media_template",
    "lang_code": "{code}",
    "template_name": "{your template}",
    "header": [
      {
        "video": {
          "link": "{sample video url hosted publicly starting with https:// and ending with file extension}",
          "file_name": "{sample media name and ending with file extension}"
        }
      }
    ],
    "body": [
      {
        "text": "{variable}"
      },
      {
        "text": "{variable}"
      }
    ],
    "button": [
      {
        "button_no": "0/1",
        "url": "{dynamic_url variable}"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
extra (string) — Additional information to include in the message.
media (required, object) — An object containing the message template details.

f). Auth Copycode :

Request Samples

{
  "phone": "+91983352xxxx",
  "media": {
    "type": "media_template",
    "template_name": "{template_name}",
    "lang_code": "{lang_code}",
    "body": [
      {
        "text": "123523"
      }
    ],
    "button": [
      {
        "button_type": "authentication",
        "button_no": "0",
        "text": "123523"
      }
    ]
  }
}

g). Auth Autofill :

Request Samples

{
  "phone": "+91983352xxxx",
  "media": {
    "type": "media_template",
    "template_name": "{template_name",
    "lang_code": "{lang_code}",
    "body": [
      {
        "text": "123523"
      }
    ],
    "button": [
      {
        "button_type": "authentication",
        "button_no": "0",
        "text": "123523"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The phone number of the recipient.
media (required, object) — An object that represents the media template itself.

h). Quick Reply With ID :

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "extra": "extra",
  "media": {
    "type": "media_template",
    "lang_code": "en",
    "template_name": "quick_reply_tim_new",
    "header": [
      {
        "image": {
          "link": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
        }
      }
    ],
    "button": [
      {
        "button_no": "0",
        "payload": "tri"
      },
      {
        "button_no": "1",
        "payload": "tan"
      }
    ]
  }
}

i). Carousel :

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "testing_carousel_pranit",
    "lang_code": "en_US",
    "body": [
      {
        "text": "15OFF"
      },
      {
        "text": "15%"
      }
    ],
    "carousel": [
      {
        "type": "image",
        "url": "https://picsum.photos/id/237/200/300",
        "body": [
          {
            "text": "10OFF"
          },
          {
            "text": "10OFF"
          }
        ],
        "button": [
          {
            "button_no": "0",
            "payload": "7C4xhY"
          },
          {
            "button_no": "1",
            "url": "summer_blues_2023"
          }
        ]
      },
      {
        "type": "image",
        "url": "https://picsum.photos/200/300?grayscale",
        "body": [
          {
            "text": "10OFF"
          },
          {
            "text": "10OFF"
          }
        ],
        "button": [
          {
            "button_no": "0",
            "payload": "7C4xhY"
          },
          {
            "button_no": "1",
            "url": "summer_blues_2023"
          }
        ]
      }
    ]
  }
}

j). Copy Code :

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "coupon_code_pranit",
    "lang_code": "en_US",
    "body": [
      {
        "text": "Sir"
      },
      {
        "text": "25"
      },
      {
        "text": "DUSSHERA23"
      },
      {
        "text": "24-10-2023"
      }
    ],
    "button": [
      {
        "button_no": "1",
        "coupon_code": "DUSSHERA23"
      }
    ]
  }
}

k). Catalog Thumbnail :

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "test_pranit_catalogue_2",
    "lang_code": "en_US",
    "body": [
      {
        "text": "Test"
      }
    ],
    "button": [
      {
        "button_no": "0",
        "thumbnail_product_retailer_id": "vendee2"
      }
    ]
  }
}

l). Multi Product Template Message :

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "testing_api_mpm9",
    "lang_code": "en_us",
    "multi_product": [
      {
        "product_thumbnail": "IT173",
        "title": "image",
        "product_retailer_ids": [
          "1",
          "1-1135-2742-HI"
        ]
      },
      {
        "title": "Premium Packages",
        "product_retailer_ids": [
          "2"
        ]
      },
      {
        "title": "Best Packages",
        "product_retailer_ids": [
          "IT1260"
        ]
      },
      {
        "title": "Premium Packages",
        "product_retailer_ids": [
          "IT173"
        ]
      }
    ]
  }
}

m). Limited Time Offer :

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "testing_api_lto111",
    "lang_code": "en",
    "body": [
      {
        "text": "Pablo"
      }
    ],
    "limited_time": [
      {
        "expiration_time": 1702373850000,
        "button": [
          {
            "button_no": "0",
            "coupon_code": "CARIBE26"
          }
        ]
      }
    ]
  }
}

n). Payment Template Message :

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": "false",
  "media": {
    "type": "media_template",
    "template_name": "testing_order_*************",
    "lang_code": "en_US",
    "payment": [
      {
        "reference_id": "12F14****",
        "order_type": "order_details",
        "product_type": "digital-goods",
        "payment_gateway": {
          "type": "razorpay",
          "configuration_name": "RPca***"
        },
        "address": {
          "first_name": "first name of recipient",
          "address_line1": "address",
          "address_line2": "address",
          "city": "city",
          "state": "state",
          "country": "India",
          "postal_code": "560066"
        },
        "items": [
          {
            "name": "test language",
            "product_id": "106299316140****",
            "quantity": "1",
            "amount": "10",
            "retailer_id": "1-1135-2*****",
            "country_of_origin": "ORIGIN_COUNTRY",
            "importer_name": "IMPORTER_NAME",
            "importer_address": {
              "address_line1": "IMPORTER_ADDRESS",
              "city": "CITY",
              "country_code": "COUNTRY",
              "postal_code": "534280"
            }
          }
        ],
        "subtotal_amount": "10",
        "discount_amount": "0",
        "shipping_amount": "0",
        "shipping_description": "optional_text",
        "total_amount": "10",
        "tax_amount": "0",
        "tax_description": "optional_text"
      }
    ]
  },
  "extra": "samplepayment"
}

O). Flow Template Message:

Request Samples

{
  "phone": "{mobile number}",
  "media": {
    "type": "media_template",
    "template_name": "nn_t***",
    "lang_code": "en",
    "header": [
      {
        "text": "offer"
      }
    ],
    "body": [
      {
        "text": "the end of August"
      },
      {
        "text": "25OFF"
      },
      {
        "text": "20%"
      }
    ],
    "button": [
      {
        "button_no": "0",
        "flow": "PAYLOAD"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The phone number of the recipient.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
extra (string) — Additional information to include in the message.
media (required, object) — An object containing the message template details.

2). a). Session Text:

Request Samples

{
  "phone": "{mobile number}",
  "text": "{sample text}",
  "enable_acculync": true,
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
text (required, string) — The text to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
extra (string) — Additional information to include in the message.

b). Session Text Reply To:

Request Samples

{
  "phone": "{mobile number}",
  "text": "{sample text}",
  "reply_to": "wamid.HBgMOTE3MDQ1MzQ1Mjg1FQIAERgSQTg5MkYxNjM3QzU5OExxxxxxxx==",
  "enable_acculync": true,
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
text (required, string) — The text to include in the message.
reply_to (required, string) — The unique identifier of the message to which the business is replying.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
extra (string) — Additional information to include in the message.

c). Session Text with Preview URL:

Request Samples

{
  "phone": "{mobile number}",
  "text": "{text with valid url}",
  "preview_url": true,
  "enable_acculync": true,
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
text (required, string) — The text to include in the message.
preview_url (boolean) — A boolean value indicating whether to include a preview of the URL in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
extra (string) — Additional information to include in the message.

d). Session Document:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "media": {
    "type": "document",
    "url": "{sample pdf url https://}",
    "file": "{sample .pdf file name}",
    "caption": "{sample text}"
  },
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the document to be sent.
extra (string) — Additional information to include in the message.

e). Session Audio:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "media": {
    "type": "audio",
    "url": "{sample .mp3 url https://}",
    "file": "{sample audio.mp3 file name}",
    "caption": "{sample text}"
  },
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the audio to be sent.
extra (string) — Additional information to include in the message.

f). Session Image:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "media": {
    "type": "image",
    "url": "{sample image url https://}",
    "file": "{sample image .jpg file name}",
    "caption": "{sample text}"
  },
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the image to be sent.
extra (string) — Additional information to include in the message.

g). Session Video:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "media": {
    "type": "video",
    "url": "{sample video url https://}",
    "file": "{sample video .mp4 file name}",
    "caption": "{sample text}"
  },
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the video to be sent.
extra (string) — Additional information to include in the message.

h). Session Location:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "media": {
    "type": "location",
    "longitude": "{example: 72.838249}",
    "latitude": "{example: 18.991341}",
    "name": "{location name}",
    "address": "{location address}"
  },
  "extra": "{your value}"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the location to be sent on the user's device..
extra (string) — Additional information to include in the message.

i). Session Interactive List:

Request Samples

{
  "phone": "{phone number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "interactive_list",
    "header": {
      "text": "ABC Food Items"
    },
    "body": "Hello TAN. Please select from the list below",
    "footer_text": "Menu",
    "button_text": "Select",
    "button": [
      {
        "section_title": "Chicken",
        "row": [
          {
            "id": "1",
            "title": "Chicken Kadai",
            "description": "tasty gravy"
          }
        ]
      },
      {
        "section_title": "Fish",
        "row": [
          {
            "id": "2",
            "title": "Fish Masala",
            "description": "yummy flavour"
          }
        ]
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
extra (string) — Additional information to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the interactive list to be sent.

j). Session Quick Reply With Media:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "interactive_reply",
    "header": {
      "type": "video",
      "url": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/xxxxxxxxxxxxxxxx.mp4",
      "file": "pdf.pdf",
      "caption": "This is a test video"
    },
    "body": "HI TAN, please select an option below",
    "footer_text": "c@2021",
    "button": [
      {
        "id": "1",
        "title": "Yes"
      },
      {
        "id": "2",
        "title": "No"
      },
      {
        "id": "3",
        "title": "Maybe"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
extra (string) — Additional information to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — A JSON object that describes the media file and quick reply options.

k). Session Quick Reply With Text:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "{your value}",
  "enable_acculync": true,
  "media": {
    "type": "interactive_reply",
    "header": {
      "text": "Super Selector Match"
    },
    "body": "HI TAN, please select an option below",
    "footer_text": "c@2021",
    "button": [
      {
        "id": "1",
        "title": "Yes"
      },
      {
        "id": "2",
        "title": "No"
      },
      {
        "id": "3",
        "title": "Maybe"
      }
    ]
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
extra (string) — Additional information to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
media (required, object) — An object containing the details of the interactive reply be sent.

l). Session Single Product:

Request Samples

{
  "phone": "{mobile number}",
  "extra": "extra",
  "enable_acculync": true,
  "catalog": {
    "type": "product",
    "body": {
      "text": "test"
    },
    "action": {
      "catalog_id": "2476762038xxxx9",
      "product_retailer_id": "pp_x1"
    }
  }
}

m). Session Multi Product:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": true,
  "extra": "extra",
  "catalog": {
    "type": "product_list",
    "header": {
      "type": "text",
      "text": "hello https://mail.google.com/"
    },
    "body": {
      "text": "test"
    },
    "action": {
      "catalog_id": "2476762038xxxx9",
      "sections": [
        {
          "title": "section 1",
          "product_items": [
            {
              "product_retailer_id": "pp_x1"
            },
            {
              "product_retailer_id": "pp_x"
            }
          ]
        },
        {
          "title": "section 2",
          "product_items": [
            {
              "product_retailer_id": "pp_x1"
            },
            {
              "product_retailer_id": "pp_x"
            }
          ]
        }
      ]
    }
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
extra (string) — Additional information to include in the message.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
catalog (required, object) — The catalog object contains information about the product list.

n). Session Flow:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "type": "flow",
  "header": {
    "image": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "footer": "this test belongs to footer",
  "body": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg",
  "flow": {
    "flow_mode": "draft",
    "flow_token": "abc********.",
    "flow_id": "856082929******",
    "flow_cta": "Book!",
    "flow_action": "navigate",
    "flow_action_payload": {
      "screen": "MY_FIRST_SCREEN",
      "data": {
        "hi": "hello"
      }
    }
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
type (required, string) — The type of message, in this case "flow".
header (required, object) — The header information for the flow message.
footer (required, string) — Text to display in the footer.
body (required, string) — The URL of the image to display in the body.
flow (required, object) — The flow object contains information about the flow message.

o). Payment Message With Catalog ID:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "with catalog",
  "footer": "this is your text",
  "image": {
    "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "payment": {
    "reference_id": "q2",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_configuration": "RML****1",
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "address_line2": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066"
    },
    "items": [
      {
        "retailer_id": "1",
        "catalog_id": "62305622836*****",
        "product_name": "Product name, for example bread",
        "amount": 100,
        "quantity": "1",
        "expiration_timestamp": "1797885016",
        "expiration_description": "expiration-explanation"
      }
    ],
    "subtotal_amount": 100,
    "discount_amount": 100,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 100,
    "tax_amount": 100,
    "tax_description": "optional_text"
  },
  "extra": "samplepayment"
}

Request Body Schema

p). Payment Message Without Catalog ID:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "without catalog_id",
  "footer": "this is your text",
  "payment": {
    "reference_id": "y**",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_configuration": "RML****1",
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "address_line2": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066"
    },
    "items": [
      {
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
        },
        "product_name": "Product name, for example bread",
        "amount": 100,
        "quantity": "1",
        "expiration_timestamp": "1797885016",
        "expiration_description": "expiration-explanation"
      }
    ],
    "subtotal_amount": 100,
    "discount_amount": 100,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 100,
    "tax_amount": 100,
    "tax_description": "optional_text",
    "extra": "samplepayment"
  }
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
body (required, string) — The body text of the message.
footer (required, string) — The text to display in the footer.
payment (required, object) — The payment object contains information about the payment details.
extra (required, string) — Additional information to include in the message.

q). Payment Message With Payu Gateway:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "payment gateway_payu",
  "footer": "this is your text",
  "image": {
    "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "payment": {
    "reference_id": "g**",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_gateway": {
      "type": "payu",
      "configuration_name": "PUca***",
      "notes": {
        "udf1": "TNXID:1221***",
        "udf2": "TNXID:1221WE***",
        "udf3": "TNXID:12WE322***"
      }
    },
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "address_line2": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066"
    },
    "items": [
      {
        "retailer_id": "1*",
        "catalog_id": "623056228363****",
        "product_name": "Product name, for example bread",
        "amount": 100,
        "quantity": "1",
        "expiration_timestamp": "1797885016",
        "expiration_description": "expiration-explanation"
      }
    ],
    "subtotal_amount": 100,
    "discount_amount": 100,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 100,
    "tax_amount": 100,
    "tax_description": "optional_text"
  },
  "extra": "samplepayment"
}

r). Payment Message With Razorpay Gateway:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "payment gateway_ razor",
  "footer": "this is your text",
  "image": {
    "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "payment": {
    "reference_id": "q9*",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_gateway": {
      "type": "razorpay",
      "configuration_name": "Rca***",
      "notes": {
        "udf1": "TNXID:12213**",
        "udf2": "TNXID:1221WEE**",
        "udf3": "TNXID:12WE322***"
      }
    },
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "address_line2": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066"
    },
    "items": [
      {
        "retailer_id": "1**",
        "catalog_id": "6230562283637***",
        "product_name": "Product name, for example bread",
        "amount": 100,
        "quantity": "1",
        "expiration_timestamp": "1797885016",
        "expiration_description": "expiration-explanation"
      }
    ],
    "subtotal_amount": 100,
    "discount_amount": 100,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 100,
    "tax_amount": 100,
    "tax_description": "optional_text"
  },
  "extra": "samplepayment"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
body (required, string) — The body text of the message.
footer (required, string) — The text to display in the footer.
image (required, object) — The image object containing the URL of the image.
payment (required, object) — The payment object containing information about the payment details.
extra (required, string) — Additional information to include in the message.

s). Payment Message With UPI:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": "true",
  "body": "from upi",
  "footer": "this is your text",
  "image": {
    "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "payment": {
    "reference_id": "qqqqq33fq***",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_configuration": "RMLUA***",
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066"
    },
    "items": [
      {
        "retailer_id": "1-1135-27*****",
        "product_name": "Cora*****",
        "amount": 10,
        "quantity": "1",
        "expiration_timestamp": "1799885016",
        "expiration_description": "expiration-explanation"
      }
    ],
    "subtotal_amount": 10,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 10,
    "tax_amount": 0,
    "tax_description": "optional_text"
  },
  "extra": "samplepayment"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (string) — A string indicating whether or not to enable Acculync. (Note- It is a string here, but it should ideally be a boolean.)
body (required, string) — The body text of the message.
footer (required, string) — The text to display in the footer.
image (required, object) — The image object containing the URL of the image.
payment (required, object) — The payment object containing information about the payment details.
extra (required, string) — Additional information to include in the message.

t). Payment Message With Payment Link:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "from link",
  "footer": "this is your text",
  "image": {
    "url": "https://upload.wikimedia.org/wikipedia/commons/3/3f/JPEG_example_flower.jpg"
  },
  "payment": {
    "reference_id": "q**",
    "order_type": "order_details",
    "product_type": "digital-goods",
    "payment_link": {
      "uri": "https://***************888888"
    },
    "address": {
      "first_name": "first name of recipient",
      "address_line1": "address",
      "address_line2": "address",
      "city": "city",
      "state": "state",
      "country": "India",
      "postal_code": "560066*********",
      "product_name": "Product name, for example bread",
      "amount": 100,
      "quantity": "1",
      "expiration_timestamp": "1797885016",
      "expiration_description": "expiration-explanation"
    },
    "subtotal_amount": 100,
    "discount_amount": 100,
    "discount_description": "optional_text",
    "shipping_amount": 0,
    "shipping_description": "optional_text",
    "total_amount": 100,
    "tax_amount": 100,
    "tax_description": "optional_text"
  },
  "extra": "samplepayment"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
body (required, string) — The body text of the message.
footer (required, string) — The text to display in the footer.
image (required, object) — The image object containing the URL of the image.
payment (required, object) — The payment object containing information about the payment details.
extra (required, string) — Additional information to include in the message.

u). Payment Order Status:

Request Samples

{
  "phone": "{mobile number}",
  "enable_acculync": false,
  "body": "this is your text",
  "payment": {
    "product_type": "digital-goods",
    "order_type": "order_status",
    "reference_id": "kjhuhouyouyu*****",
    "order_status": "processing",
    "order_status_description": "optional-text"
  },
  "extra": "samplepayment"
}

Request Body Schema

phone (required, string) — The mobile number of the recipient in full international format includes a plus sign (+) followed by the country code.
enable_acculync (boolean) — A boolean indicating whether or not to enable Acculync.
body (required, string) — The body text of the message.
payment (required, object) — The payment object containing information about the order status.
extra (required, string) — Additional information to include in the message.