PureBasic / Infobip WhatsApp / Create WhatsApp Template
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"name","example_template_name_{{$randomInt}}_{{$randomInt}}")
CkJsonObject::ckUpdateString(json,"language","en")
CkJsonObject::ckUpdateString(json,"category","ACCOUNT_UPDATE")
CkJsonObject::ckUpdateString(json,"structure.body","body {{1}} content")
CkJsonObject::ckUpdateString(json,"structure.type","TEXT")
CkHttp::ckSetRequestHeader(http,"Authorization","App {{INFOBIP_API_KEY}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/whatsapp/1/senders/:sender/templates","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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.s = CkJsonObject::ckStringOf(jResp,"id")
businessAccountId.i = CkJsonObject::ckIntOf(jResp,"businessAccountId")
name.s = CkJsonObject::ckStringOf(jResp,"name")
language.s = CkJsonObject::ckStringOf(jResp,"language")
status.s = CkJsonObject::ckStringOf(jResp,"status")
category.s = CkJsonObject::ckStringOf(jResp,"category")
Body.s = CkJsonObject::ckStringOf(jResp,"structure.body")
v_Type.s = CkJsonObject::ckStringOf(jResp,"structure.type")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}