Ruby / Infobip WhatsApp / Create WhatsApp Template
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "name": "example_template_name_{{$randomInt}}_{{$randomInt}}",
# "language": "en",
# "category": "ACCOUNT_UPDATE",
# "structure": {
# "body": "body {{1}} content",
# "type": "TEXT"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("name","example_template_name_{{$randomInt}}_{{$randomInt}}")
json.UpdateString("language","en")
json.UpdateString("category","ACCOUNT_UPDATE")
json.UpdateString("structure.body","body {{1}} content")
json.UpdateString("structure.type","TEXT")
http.SetRequestHeader("Authorization","App {{INFOBIP_API_KEY}}")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/whatsapp/1/senders/:sender/templates","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "1072288653542716",
# "businessAccountId": 2125987241021795,
# "name": "example_template_name_767_413",
# "language": "en",
# "status": "PENDING",
# "category": "ACCOUNT_UPDATE",
# "structure": {
# "body": "body {{1}} content",
# "type": "TEXT"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id = jResp.stringOf("id")
businessAccountId = jResp.IntOf("businessAccountId")
name = jResp.stringOf("name")
language = jResp.stringOf("language")
status = jResp.stringOf("status")
category = jResp.stringOf("category")
Body = jResp.stringOf("structure.body")
v_Type = jResp.stringOf("structure.type")
Curl Command
curl -X POST
-H "Authorization: App {{INFOBIP_API_KEY}}"
-H "Content-Type: application/json"
-d '{
"name": "example_template_name_{{$randomInt}}_{{$randomInt}}",
"language": "en",
"category": "ACCOUNT_UPDATE",
"structure": {
"body": "body {{1}} content",
"type": "TEXT"
}
}'
https://domain.com/whatsapp/1/senders/:sender/templates
Postman Collection Item JSON
{
"name": "Create WhatsApp Template",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 201, template created\", function () {",
" pm.response.to.have.status(201);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example_template_name_{{$randomInt}}_{{$randomInt}}\",\n \"language\": \"en\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"structure\": {\n \"body\": \"body {{1}} content\",\n \"type\": \"TEXT\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/senders/:sender/templates",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"senders",
":sender",
"templates"
],
"variable": [
{
"key": "sender",
"value": "{{senderNumber}}",
"description": "(Required) Registered WhatsApp sender number. Must be in international format."
}
]
},
"description": "Create WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/message-types#guidelines-amp-best-practices) for additional info."
},
"response": [
{
"name": "Text template simple",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example_template_name_{{$randomInt}}_{{$randomInt}}\",\n \"language\": \"en\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"structure\": {\n \"body\": \"body {{1}} content\",\n \"type\": \"TEXT\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/senders/:sender/templates",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"senders",
":sender",
"templates"
],
"variable": [
{
"key": "sender",
"value": "{{senderNumber}}",
"description": "(Required) Registered WhatsApp sender number. Must be in international format."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 10:36:58 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636367818279895837"
}
],
"cookie": [
],
"body": "{\n \"id\": \"1072288653542716\",\n \"businessAccountId\": 2125987241021795,\n \"name\": \"example_template_name_767_413\",\n \"language\": \"en\",\n \"status\": \"PENDING\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"structure\": {\n \"body\": \"body {{1}} content\",\n \"type\": \"TEXT\"\n }\n}"
},
{
"name": "Complex template with buttons and image",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example_template_name_{{$randomInt}}_{{$randomInt}}\",\n \"language\": \"en\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"structure\": {\n \"header\": {\n \"format\": \"IMAGE\"\n },\n \"body\": \"body {{1}} content\",\n \"footer\": \"this is footer\",\n \"buttons\": [\n {\n \"text\": \"Yes\",\n \"type\": \"QUICK_REPLY\"\n },\n {\n \"text\": \"No\",\n \"type\": \"QUICK_REPLY\"\n }\n ],\n \"type\": \"MEDIA\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/senders/:sender/templates",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"senders",
":sender",
"templates"
],
"variable": [
{
"key": "sender",
"value": "{{senderNumber}}",
"description": "(Required) Registered WhatsApp sender number. Must be in international format."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 10:50:20 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636368620308994838"
}
],
"cookie": [
],
"body": "{\n \"id\": \"452107629693501\",\n \"businessAccountId\": 2125987241021795,\n \"name\": \"example_template_name_225_786\",\n \"language\": \"en\",\n \"status\": \"PENDING\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"structure\": {\n \"header\": {\n \"format\": \"IMAGE\"\n },\n \"body\": \"body {{1}} content\",\n \"footer\": \"this is footer\",\n \"buttons\": [\n {\n \"text\": \"Yes\",\n \"type\": \"QUICK_REPLY\"\n },\n {\n \"text\": \"No\",\n \"type\": \"QUICK_REPLY\"\n }\n ],\n \"type\": \"MEDIA\"\n }\n}"
}
]
}
