PureBasic Requires Chilkat v11.0.0+
PureBasic
Clickatell One API: Upload and send a WhatsApp PDF
See more Clickatell Examples
Send a local invoice.pdf during the customer’s open WhatsApp service window. Upload the binary PDF for one recipient, then reference the returned fileId in a separate message to the same recipient. The upload and message submission have separate acceptance results.
Chilkat PureBasic Downloads
IncludeFile "CkBinData.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
; Assumes Chilkat is unlocked. See Global Unlock Sample.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttp::setCkRequireSslCertVerify(http, 1)
; Load the key for this One API integration from your application configuration.
CkHttp::ckSetRequestHeader(http,"Authorization","ONE_API_KEY")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
recipient.s = "PHONE_NUMBER"
pdf.i = CkBinData::ckCreate()
If pdf.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
loaded.i = CkBinData::ckLoadFile(pdf,"invoice.pdf")
If loaded <> 1
Debug "Could not read invoice.pdf."
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
ProcedureReturn
EndIf
; Restrict this customer's invoice to that customer's number.
CkHttp::ckSetUrlVar(http,"recipient",recipient)
upload.i = CkHttpResponse::ckCreate()
If upload.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
uploaded.i = CkHttp::ckHttpBd(http,"POST","https://platform.clickatell.com/v1/media?fileName=invoice.pdf&to={$recipient}",pdf,"application/pdf",upload)
If (uploaded <> 1) OR (CkHttpResponse::ckStatusCode(upload) <> 201)
Debug "PDF upload failed. HTTP status " + Str(CkHttpResponse::ckStatusCode(upload))
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
ProcedureReturn
EndIf
media.i = CkJsonObject::ckCreate()
If media.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
decoded.i = CkJsonObject::ckLoad(media,CkHttpResponse::ckBodyStr(upload))
If (decoded <> 1) OR (CkJsonObject::ckBoolOf(media,"accepted") <> 1)
Debug "Upload was not accepted: " + CkJsonObject::ckStringOf(media,"error.description")
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
ProcedureReturn
EndIf
fileId.s = CkJsonObject::ckStringOf(media,"fileId")
If (CkJsonObject::ckJsonTypeOf(media,"fileId") <> 1) OR (fileId = "")
Debug "Upload returned no file ID."
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
ProcedureReturn
EndIf
body.i = CkJsonObject::ckCreate()
If body.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(body,"messages[0].channel","whatsapp")
CkJsonObject::ckUpdateString(body,"messages[0].to",recipient)
CkJsonObject::ckUpdateString(body,"messages[0].media.fileId",fileId)
CkJsonObject::ckUpdateString(body,"messages[0].media.contentType","application/pdf")
CkJsonObject::ckUpdateString(body,"messages[0].media.fileName","invoice.pdf")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sent.i = CkHttp::ckHttpJson(http,"POST","https://platform.clickatell.com/v1/message",body,"application/json",resp)
If CkHttpResponse::ckStatusCode(resp) = 0
Debug "No HTTP response. Check the message report before resending."
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
reply.i = CkJsonObject::ckCreate()
If reply.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
parsed.i = CkJsonObject::ckLoad(reply,CkHttpResponse::ckBodyStr(resp))
If (sent <> 1) OR (CkHttpResponse::ckStatusCode(resp) <> 202)
Debug "Send returned HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
If CkJsonObject::ckHasMember(reply,"error.description") = 1
Debug CkJsonObject::ckStringOf(reply,"error.description")
EndIf
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndIf
If CkJsonObject::ckHasMember(reply,"error.code") = 1
If CkJsonObject::ckIsNullOf(reply,"error.code") <> 1
Debug "Submission error " + CkJsonObject::ckStringOf(reply,"error.code") + " " + CkJsonObject::ckStringOf(reply,"error.description")
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndIf
EndIf
; HTTP acceptance and the recipient result are separate checks.
If (parsed <> 1) OR (CkJsonObject::ckJsonTypeOf(reply,"messages[0].accepted") <> 5)
Debug "Missing recipient result. Check the message report."
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndIf
If CkJsonObject::ckBoolOf(reply,"messages[0].accepted") <> 1
Debug "Message rejected: " + CkJsonObject::ckStringOf(reply,"messages[0].error.code") + " " + CkJsonObject::ckStringOf(reply,"messages[0].error.description")
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndIf
If CkJsonObject::ckJsonTypeOf(reply,"messages[0].apiMessageId") <> 1
Debug "Accepted without a message ID. Check the message report."
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndIf
Debug "Accepted. Message ID: " + CkJsonObject::ckStringOf(reply,"messages[0].apiMessageId")
CkHttp::ckDispose(http)
CkBinData::ckDispose(pdf)
CkHttpResponse::ckDispose(upload)
CkJsonObject::ckDispose(media)
CkJsonObject::ckDispose(body)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(reply)
ProcedureReturn
EndProcedure