Sinch Engage: Authenticate a GET Request with HMAC-SHA256
See more Sinch Engage Examples
Use an Engage HMAC API key/secret to sign a read-only message-status request. This is an alternative to Basic authentication. The signature covers the Date header and exact HTTP request line, separated by one LF, with no final newline. Base64-encode the raw HMAC-SHA256 bytes, not hexadecimal text. Keep the clock accurate and sign again for each request.
This no-body GET example deliberately omits Content-MD5. For a request with a body, follow Engage's additional Content-MD5/signing requirements and hash the exact transmitted bytes. API request HMAC and RSA-signed webhook verification are different mechanisms. Parent-account requests can use the documented Account header on supported resources; never assume that header applies to every API family.
Sinch Engage is the renamed MessageMedia platform. This uses the Engage API, not Sinch Conversation API credentials or endpoints. Create an Engage API key/secret and place {"api_key":"YOUR_KEY","api_secret":"YOUR_SECRET"} in private sinch-engage.json. Select the account's regional HTTPS host: https://au.app.api.sinch.com, https://eu.app.api.sinch.com, or https://us.app.api.sinch.com. Basic authentication here means the API key/secret over verified TLS. Do not ship account credentials in a public mobile, browser, or desktop application.
Transport success and API success are checked separately. On HTTP 429, honor Retry-After before a bounded retry. Check account permissions and regional credentials for 401/403. A timeout or 5xx response after submitting a write can leave its outcome uncertain: reconcile before retrying, especially sends and resource creation. Metadata is correlation data, not an idempotency key. Inspect error bodies privately because they can contain phone numbers and message content.
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loConfig
LOCAL lcApiHost
LOCAL loHttp
LOCAL loUrl
LOCAL loResp
LOCAL loResult
LOCAL lcMessageId
LOCAL loPath
LOCAL loNow
LOCAL lcDateHeader
LOCAL loSigning
LOCAL loMac
LOCAL lcSignature
LOCAL loAuthorization
lnSuccess = 0
* Assumes Chilkat is unlocked. See Global Unlock Sample.
* Store real credentials in private configuration, never in distributed client code.
loConfig = CreateObject('Chilkat.JsonObject')
loConfig.Strict = 1
lnSuccess = loConfig.LoadFile("sinch-engage.json")
IF (lnSuccess <> 1) THEN
? "Could not load private sinch-engage.json."
RELEASE loConfig
CANCEL
ENDIF
IF ((loConfig.JsonTypeOf("api_key") <> 1) OR (loConfig.StringOfEquals("api_key","",1) = 1) OR (loConfig.JsonTypeOf("api_secret") <> 1) OR (loConfig.StringOfEquals("api_secret","",1) = 1)) THEN
? "The private configuration must contain api_key and api_secret."
RELEASE loConfig
CANCEL
ENDIF
* Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
lcApiHost = "https://au.app.api.sinch.com"
loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.FollowRedirects = 0
loHttp.ConnectTimeout = 20
loHttp.ReadTimeout = 30
loHttp.SetRequestHeader("Accept","application/json")
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loResult = CreateObject('Chilkat.JsonObject')
loResult.Strict = 1
lcMessageId = "YOUR_MESSAGE_ID"
loPath = CreateObject('Chilkat.StringBuilder')
loPath.Append("/v1/messages/")
loPath.Append(loHttp.UrlEncode(lcMessageId))
loNow = CreateObject('Chilkat.CkDateTime')
lnSuccess = loNow.SetFromCurrentSystemTime()
IF (lnSuccess <> 1) THEN
? "Could not get the signing time."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
CANCEL
ENDIF
lcDateHeader = loNow.GetAsRfc822(0)
loSigning = CreateObject('Chilkat.StringBuilder')
loSigning.Append("Date: ")
loSigning.Append(lcDateHeader)
loSigning.Append(CHR(10) + "GET ")
loSigning.Append(loPath.GetAsString())
loSigning.Append(" HTTP/1.1")
loMac = CreateObject('Chilkat.Crypt2')
loMac.MacAlgorithm = "hmac"
loMac.HashAlgorithm = "sha256"
loMac.Charset = "utf-8"
loMac.EncodingMode = "base64"
lnSuccess = loMac.SetMacKeyString(loConfig.StringOf("api_secret"))
IF (lnSuccess <> 1) THEN
? "Could not set the signing key."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
CANCEL
ENDIF
lcSignature = loMac.MacStringENC(loSigning.GetAsString())
IF (loMac.LastMethodSuccess <> 1) THEN
? "Could not sign the request."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
CANCEL
ENDIF
loAuthorization = CreateObject('Chilkat.StringBuilder')
loAuthorization.Append('hmac username="')
loAuthorization.Append(loConfig.StringOf("api_key"))
loAuthorization.Append('", algorithm="hmac-sha256", headers="Date request-line", signature="')
loAuthorization.Append(lcSignature)
loAuthorization.Append('"')
loHttp.SetRequestHeader("Date",lcDateHeader)
loHttp.SetRequestHeader("Authorization",loAuthorization.GetAsString())
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("")
loUrl.Append(loPath.GetAsString())
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
* HttpJson/HttpNoBody also return false for HTTP 4xx/5xx responses.
IF ((lnSuccess <> 1) AND (loResp.StatusCode = 0)) THEN
? "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
RELEASE loAuthorization
CANCEL
ENDIF
IF ((loResp.StatusCode <> 200)) THEN
? "Unexpected HTTP status: " + STR(loResp.StatusCode)
IF (loResp.StatusCode = 429) THEN
? "Retry-After: " + loResp.GetHeaderField("Retry-After")
ENDIF
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
RELEASE loAuthorization
CANCEL
ENDIF
lnSuccess = loResult.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
? "Expected a JSON response."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
RELEASE loAuthorization
CANCEL
ENDIF
? "Current status: " + loResult.StringOf("status")
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loPath
RELEASE loNow
RELEASE loSigning
RELEASE loMac
RELEASE loAuthorization