Sample code for 30+ languages & platforms
Visual Basic 6.0 Requires Chilkat v11.0.0+

Clickatell One API: Look up SMS delivery status

See more Clickatell Examples

Use the apiMessageId returned by the One API send example and the same integration key. The ID goes in the URL path. The SMS result contains sms.status and the timestamp of the last status change. For example, QUEUED means processing is pending and DEVICE_ACK indicates a device acknowledgment.

The response can also contain a WhatsApp result or have no identifiable channel for an unknown message. For ongoing delivery updates, configure delivery notifications in the integration. This example performs one lookup.

Clickatell API reference

Chilkat Visual Basic 6.0 Downloads

Visual Basic 6.0
Dim success As Long
success = 0

'  Assumes Chilkat is unlocked. See Global Unlock Sample.
Dim http As New ChilkatHttp
http.RequireSslCertVerify = 1
'  Supply the key for this One API integration from application configuration.
http.SetRequestHeader "Authorization","ONE_API_KEY"
http.SetRequestHeader "Accept","application/json"

'  Use the provider-generated ID from an accepted One API send.
success = http.SetUrlVar("id","ONE_API_MESSAGE_ID")
Dim resp As New ChilkatHttpResponse
success = http.HttpNoBody("GET","https://platform.clickatell.com/v1/message/{$id}",resp)
If (resp.StatusCode = 0) Then
    Debug.Print "No HTTP response. Check the connection and retry the lookup."
    Exit Sub
End If

Dim reply As New ChilkatJsonObject
Dim parsed As Long
parsed = reply.Load(resp.BodyStr)
If ((success <> 1) Or ((resp.StatusCode <> 200))) Then
    Debug.Print "Clickatell returned HTTP " & resp.StatusCode
    If (parsed = 1) Then
        If (reply.HasMember("error.description") = 1) Then
            Debug.Print reply.StringOf("error.description")
        End If

    End If

    Exit Sub
End If

If (parsed <> 1) Then
    Debug.Print "Expected a JSON response."
    Exit Sub
End If

'  A known SMS has a string status under the sms member.
If (reply.JsonTypeOf("sms.status") <> 1) Then
    If (reply.JsonTypeOf("whatsapp.status") = 1) Then
        Debug.Print "This message has WhatsApp status: " & reply.StringOf("whatsapp.status")
    Else
        Debug.Print "No SMS status was returned. Check the message ID and integration."
        If (reply.JsonTypeOf("status") = 1) Then
            Debug.Print "Reported status: " & reply.StringOf("status")
        End If

    End If

    Exit Sub
End If

Debug.Print "SMS status: " & reply.StringOf("sms.status")
If (reply.JsonTypeOf("sms.timestamp") = 2) Then
    '  Read the provider timestamp as text to preserve every digit.
    Debug.Print "Last status change (provider timestamp): " & reply.StringOf("sms.timestamp")
End If