Official Api Documentation

# Tamplates

# Get Templates


pay attention

Currently you can create a new template only via our website.

# Endpoint

GET https://019sms.co.il/whatsapp-api/get-phone-templates/:phone/:templateId?
Name Type Required
Authorization Bearer authentication ✔️
Content-Type application/json ✔️

# Request parameters

Name Type Description Required
phone string Your WhatsApp number. international number without +. for example: 972771234567 ✔️
templateId string The specific template ID for which you would like to receive data. ➖



# Response example

Content-Type: application/json

{
    "success": true,
    "templates": [
        {
            "name": "תבנית עם תמונה ",
            "templateId": "111_972555555555_oift853",
            "language": "1",
            "headerSample": "https://docs.019sms.co.il/019sms_new400.png",
            "body": "זוהי הודעת בדיקה עם תמונה מצורפת",
            "footer": "",
            "buttons": "1",
            "callToAction": "0",
            "callToActionWebsiteText": "",
            "callToActionWebsiteType": "",
            "callToActionWebsiteURL": "",
            "callToActionCallText": "",
            "callToActionCallNumber": "",
            "quickReply1": "",
            "quickReply2": "",
            "quickReply3": "",
            "headers": "2",
            "status": 0
        },
        {
            "name": "תבנית עם שדות דינמיים",
            "templateId": "111_972555555555_dfgt854",
            "language": "1",
            "headerSample": "",
            "body": "תושבי {{1}} היקרים,\nבשעה זו אנו נערכים למצב חירום. \nיש מחסור בבמבות מהשעה {{2}} .\n",
            "footer": "",
            "buttons": "1",
            "callToAction": "0",
            "callToActionWebsiteText": "",
            "callToActionWebsiteType": "",
            "callToActionWebsiteURL": "",
            "callToActionCallText": "",
            "callToActionCallNumber": "",
            "quickReply1": "",
            "quickReply2": "",
            "quickReply3": "",
            "headers": "1",
            "status": 0
        }
    ]
}

# Response parameters

Name Type Description Options
success boolean The status of request true/false
templates array of objects Array of object that contains information about your templates
templates -> name string The template name
templates -> templateId string The template id to use when you want to send this template
templates -> headerSample string The link to sample of media
templates -> body string The body message
templates -> footer string The footer message
templates -> buttons string Buttons types in the template 1 - No buttons
2 - for "call to action" only
3 - for "quick reply" only
4 - both call to action and quick reply combination
templates -> callToAction string setup the call to action 1 - One website button only
2 - Call button only
3 - One website + Call button
templates -> callToActionWebsiteText string The website text to show
templates -> callToActionWebsiteType string website link type 1 - for static URL (meaning, no variable)
2 - for dynamic with one variable automatically added at the end of the URL
templates -> callToActionWebsiteURL string Website link URL
templates -> callToActionCallText string The button text for the call
templates -> callToActionCallNumber string The number to dial, with country code and +
templates -> quickReply 1-3 string The quick reply buttons.
templates -> headers string The media type chose to be sent as part of the template 1 - no media
2 - image
3 - video
4 - document
templates -> status string The status of the template 0 - send for approval
1 - approved
2 - Template rejected. reason: wrong format template / too many variables / template is similar to other template already exist in your account.
3 - Template rejected. reason: The template contains content that is violating WhatsApp policy.
4 -Template rejected. reason: The template contains content that is marked as Spam.
5 - Template rejected. reason unknown.
6 - Template received too many spam reports. you cant use this template for the next 6 hours.
7 - Template is banned to use due to too many spam reports.

# Send a template

# Remarks

  • You can only send template messages to private people, not groups.
  • If you send a template message to the client, and the client did not reply yet, and you want to send another message to him, you must use the template message again.
  • The billing is per "conversation". conversation means a 24 hours session between you and the client (this 24 hours conversation session is unrelated to the 24 hours timer for template message).
  • You can send unlimited template messages within the 24 hours session time of a conversation.
  • 24 hours session conversation starts when you send a message to the client.
  • Every time the user replies, the template message session resets. which means that you don't have to use template message during this 24 hours template message session.
  • If your template has variables, you must provide all variables data (inside bodyVariable parameter).
  • The entire template body + variables should not exceed 1024 characters.
  • You can send up to 2 template message without getting any response,afterwards you will get an error.

# Endpoint

POST https://019sms.co.il/whatsapp-api/send-whatsapp-template

# Header

Name Type Required
Authorization Bearer authentication ✔️
Content-Type application/json ✔️

# Request parameters

Name Type Description Required
source string Your WhatsApp account. international number without +. for example: 972771234567 ✔️
destination string The number you want to send the message to. for example: 972501234567 ✔️
templateId string The template id you want to send ✔️
dynamicFieldsObject string In case you used variables 1 to 5 with your body when submitting the template, this is where you provide them. Each item as a variable (1 to 5), not array. Two important rules: 1. you can not use \n new line inside a variable. 2. you can not use 4 or more consecutive spaces inside a variable ➖
couponCode string in case you used coupon code in the template, here you put the code. 15 digits maximum. ➖
couponExpiration string in case you used coupon code in the template, and set 'true' for code expiration, here you put the expiration date for example: "13/05/2025 12:02" ➖
headerLink string In case you used image/video/document header, this is the link for image or video or document ➖
websiteVariable string in case you used call to action button, and you chose dynamic "website" here you should put the dynamic field ➖
websiteVariable2 string in case you used second website for call to action button, and you used dynamic variable here you should put the dynamic field ➖

# Request example

POST whatsapp-api/send-whatsapp-template HTTPS/1.1
Content-Type: application/json

{
    "source": 972555555555,
    "destination": 972550000000,
    "templateId": "111_972555555555_dfgt854",
    "dynamicFieldsObject": {
        "1": "dana",
        "2": "marom",
        "3": "1.1.25",
        "4": "",
        "5": ""
    },
    "couponCode":"123456",
    "couponExpiration": "13/05/2025 12:02",
    "headerLink": "https://docs.019sms.co.il/019sms_new400.png",
    "websiteVariable": "1111",
    "websiteVariable2": "2222"
}



# Response example

Content-Type: application/json
{
    "success": true,
    "ans": {
        "status": "OK",
        "unique": "HBgMOTcyNTI2ODkzMjQ1FQIAERgSRdDU4RjIyQjY2MEI5NUVEMUM4AA==",
        "timestamp": 1735648695,
        "from": 972555555555,
        "to": "972550000000",
        "body": "Hi dana , thank you for calling",
        "templateTimeLeft": 0,
        "conversationTimeLeft": 0,
        "reason": 1
    }
}

# Response parameters

Name Type Description Options
success boolean The status of request. true/false
ans -> status string Status of sending the message OK / FAIL
ans -> unique string Unique ID for any message
ans -> body string The text you sent
ans -> timestamp timestamp Time stamp
ans -> from string Your WhatsApp account
ans -> to string The number that the message was sent to
ans -> templateTimeLeft number Amount of minutes left since client's last message. if passed, you must use Template Message. This value resets every time the client is sending you a message.
ans -> conversationTimeLeft number Amount of minutes left for the conversation session to end. if passed, any message after that, will be considered as a new conversation, and the timer will reset.
ans -> reason string The status explanation in case of FAIL see the table below

# Reason explanation

Reason Description
1 Not FAIL. the status is OK
2 Your "from" number account does not exist, or JSON syntax error
3 General error
4 'to' is either empty or wrong number format or WhatsApp number does not exist
6 WhatsApp error or template rejected
12 Problem with the template name, or variables structure, please check the variables and the structure of the template
13 Language is empty, invalid or does not fit the language of the template when created
14 headerType is empty, invalid or does not fit the header of the template when created. moreover, body / header variables can not have new lines \n
15 You must provide headerVariable for this template, without special characters such as **
17 bodyVariable must be equal to the number of variables used when creating the template, and must not be empty.
18 You must provide websiteVariable for this template
19 The template you created is too long (more than 1024), create another one
20 The template needs a coupon code / expiration time or the coupon code / expiration time is too long or invalid
21 WhatsApp has rejected the sending of the template due to high volume sending. please try to send again.
22 Rate limit error, try again

# Send template campaign

when to use?

You should use the "Send template campaign" API in the following scenarios:

  • Sending template messages to multiple destinations in bulk.
  • Delivering template messages to a predefined contact list.
  • Scheduling a future campaign with specific timing.

# Remarks

  • You can only send template messages to private people, not groups.
  • If you send a template message to the client, and the client did not reply yet, and you want to send another message to him, you must use the template message again.
  • The billing is per "conversation". conversation means a 24 hours session between you and the client (this 24 hours conversation session is unrelated to the 24 hours timer for template message).
  • You can send unlimited template messages within the 24 hours session time of a conversation.
  • 24 hours session conversation starts when you send a message to the client.
  • Every time the user replies, the template message session resets. which means that you don't have to use template message during this 24 hours template message session.
  • If your template has variables, you must provide all variables data (inside bodyVariable parameter).
  • The entire template body + variables should not exceed 1024 characters.

# Endpoint

POST https://019sms.co.il/whatsapp-api/create-campaign-wa

# Header

Name Type Required
Authorization Bearer authentication ✔️
Content-Type application/json ✔️

# Request parameters

Name Type Description Required
source string Your WhatsApp account. international number without +. for example: 972771234567 ✔️
destinations object The destinations object whis optional keys [phones,cl] ✔️
destinations -> phones array of strings Array of strings represents phone numbers. for example : :["972552222222","972553333333"]
destinations -> cl array of strings Array of strings represents contact list id. for example : :["762524","762525"]
campaign_message string The template id you want to send ✔️
campaign_name string A name for the campaign ➖
dynamicHeaders object In case you used variables 1 to 5 with your body when submitting the template, this is where you provide them. Each item as a dynamic field from your contact list. you can use the original colmn name or just use "df1"," df2" etc. ➖
dynamicHeaders -> 1-5 string The dynamic field from your contact list to replace with. you can use "df1"," df2" etc.
header_link string In case you used image/video/document header, this is the link for image or video or document ➖
future_campaign string In case you want to add timing, put the value "future" otherwise "instant" ➖
from_date string In case you want to add timing, put the date here in this format "05/01/2025 14:30" ➖
couponCode string in case you used coupon code in the template, here you put the code. 15 digits maximum. you can use dynamic field, example for field dynamic 4 put "couponCode":"4", ➖
couponExpiration string in case you used coupon code in the template, and set 'true' for code expiration, here you put the expiration date for example: "13/05/2025 12:02" ➖
couponType string in case you used coupon code in the template, here you put the coupon type, 1 for permennent code 2 for dynamic code.
websiteVariable string in case you used call to action button, and you chose dynamic "website" here you should put the dynamic field, example for field dynamic 4 put "websiteVariable" :4 ➖
websiteVariable2 string in case you used second website for call to action button, and you used dynamic variable here you should put the dynamic field, example for field dynamic 4 put "websiteVariable" :4 ➖

# Request example

POST whatsapp-api/create-campaign-wa HTTPS/1.1
Content-Type: application/json

{
    "destinations": {
        "phones":["972552222222"],
        "cl":["762524"]
    },
    "campaign_message": "1234_972555555555_2phcys",
    "future_campaign": "future",
    "from_date": "05/01/2025 14:30",
    "campaign_name": "",
    "header_link": "https://static.whatsapp.net/rsrc.php/v3/y7/r/DSxOAUB0raA.png",
    "source": 972555555555,
    "dynamicHeaders":{
        "1": "df1",
        "2": "df4"
        "3": "df2"
        "4": "df3"
        "5": "df5"
    },
    "couponCode":"123456",
    "couponExpiration": "13/05/2025 12:02",
    "websiteVariable": "2",
    "websiteVariable2": "2"
}



# Response example

Content-Type: application/json

{
    "data": {
        "success": true,
        "sum": 2
    }
}

# Response parameters

Name Type Description Options
success boolean The status of request. true/false
sum number The total amount of destinations numbers received,also the estimations of credits cost
Last Updated: 8/31/2025, 12:15:42 PM

← Send Message →