SMsmsportal
Messages

Send a single template message.

Example request:

POST /whatsapp/v1/messages/templates
{
    "templateName": "MyFirstTemplate",
    "businessPhoneNumberId": "841234567890",
    "language": "en",
    "recipient": "27000000001",
}
post/whatsapp/v1/messages/templates

Request

  • Base URL
    https://rest.smsportal.com
  • URL
    https://rest.smsportal.com/whatsapp/v1/messages/templates
  • Auth
    HTTP basic

Request body

templateNamestring required

The name of the template to use for the send content

businessPhoneNumberIdstring required

The id of the business phone number to send the message from

languagestring required

Which language version of the template to use

recipientstring nullable

This field can contain a phone number or a BSUID.

destinationNumberstring nullable

This is a legacy field that we are keeping around until all customers have migrated to using the Recipient field. It is recommended to use the Recipient field instead of this one.

customerIdstring nullable

Optional value that can be used to track this message through the SMSPortal system.

Example request

{
  "templateName": "MyFirstTemplate",
  "businessPhoneNumberId": "841234567890",
  "language": "en"
}

Response

The template message was sent successfully

errorCodestring nullable required
errorDetailstring nullable required
templateNamestring nullable required
businessPhoneNumberIdstring nullable required
recipientstring nullable required
destinationNumberstring nullable
customerIdstring nullable required
messageIdinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.