PureBasic / Twilio Messaging / SMS / List all messages sent from your Twilio number
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkDtObj.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
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{TWILIO_ACCOUNT_SID}}")
CkHttp::setCkPassword(http, "{{TWILIO_AUTH_TOKEN}}")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"From","{{TWILIO_PHONE_NUMBER}}")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.twilio.com/2010-04-01/Accounts/:AccountSid/Messages.json",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "end": 51142961,
; "first_page_uri": "https://ZvltuXKxENEyvG.fnbzDIxrccIwHE6GxsyHjMd",
; "messages": [
; {
; "account_sid": "AC9E",
; "api_version": "commodo sint sunt eu",
; "body": "ut cillum",
; "date_created": "fugiat ipsum enim quis",
; "date_sent": "o",
; "date_updated": "laborum id esse elit",
; "direction": "outbound-reply",
; "error_code": 89665305,
; "error_message": "deserunt",
; "from": "anim esse",
; "messaging_service_sid": "MGC0",
; "num_media": "enim et",
; "num_segments": "quis qui ipsum",
; "price": "exercitation Duis",
; "price_unit": "consequat qu",
; "sid": "SMe5",
; "status": "scheduled",
; "subresource_uris": {},
; "to": "nulla",
; "uri": "cillum ut in irure"
; },
; {
; "account_sid": "ACD4",
; "api_version": "incididunt in non",
; "body": "deserunt incididunt irure eiusmod",
; "date_created": "sint ea",
; "date_sent": "Ut ut consectetur",
; "date_updated": "non dolore",
; "direction": "outbound-api",
; "error_code": -69524035,
; "error_message": "dolore Ut officia",
; "from": "reprehenderit",
; "messaging_service_sid": "MGEe",
; "num_media": "voluptate fugiat eiusmod qui Ut",
; "num_segments": "ea",
; "price": "consequat",
; "price_unit": "fugiat aliquip",
; "sid": "MM38",
; "status": "received",
; "subresource_uris": {},
; "to": "in tempor labore eiusmod",
; "uri": "elit non dol"
; }
; ],
; "next_page_uri": "http://fSikGpthYZQbOt.sncsPW4TzW44TkKnuDgx8f2FJz.",
; "page": -43897926,
; "page_size": 12121047,
; "previous_page_uri": "https://lSrGpSrECCMzKudcyRlwJdfhlnZEaAQ.hytgI,rCvOIy,x1C6vbgTvc9p6X2hkAdrqkd5jx8JKwJPiCrpsg2w",
; "start": -23084704,
; "uri": "https://USSzIQwA.hvxpmaT2476DlQGIi"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
date_created.i = CkDtObj::ckCreate()
If date_created.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
date_sent.i = CkDtObj::ckCreate()
If date_sent.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
date_updated.i = CkDtObj::ckCreate()
If date_updated.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
account_sid.s
api_version.s
body.s
direction.s
error_code.i
error_message.s
from.s
messaging_service_sid.s
num_media.s
num_segments.s
price.s
price_unit.s
sid.s
status.s
v_to.s
v_end.i = CkJsonObject::ckIntOf(jResp,"end")
first_page_uri.s = CkJsonObject::ckStringOf(jResp,"first_page_uri")
next_page_uri.s = CkJsonObject::ckStringOf(jResp,"next_page_uri")
page.i = CkJsonObject::ckIntOf(jResp,"page")
page_size.i = CkJsonObject::ckIntOf(jResp,"page_size")
previous_page_uri.s = CkJsonObject::ckStringOf(jResp,"previous_page_uri")
start.i = CkJsonObject::ckIntOf(jResp,"start")
uri.s = CkJsonObject::ckStringOf(jResp,"uri")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"messages")
While i < count_i
CkJsonObject::setCkI(jResp, i)
account_sid = CkJsonObject::ckStringOf(jResp,"messages[i].account_sid")
api_version = CkJsonObject::ckStringOf(jResp,"messages[i].api_version")
body = CkJsonObject::ckStringOf(jResp,"messages[i].body")
CkJsonObject::ckDtOf(jResp,"messages[i].date_created",0,date_created)
CkJsonObject::ckDtOf(jResp,"messages[i].date_sent",0,date_sent)
CkJsonObject::ckDtOf(jResp,"messages[i].date_updated",0,date_updated)
direction = CkJsonObject::ckStringOf(jResp,"messages[i].direction")
error_code = CkJsonObject::ckIntOf(jResp,"messages[i].error_code")
error_message = CkJsonObject::ckStringOf(jResp,"messages[i].error_message")
from = CkJsonObject::ckStringOf(jResp,"messages[i].from")
messaging_service_sid = CkJsonObject::ckStringOf(jResp,"messages[i].messaging_service_sid")
num_media = CkJsonObject::ckStringOf(jResp,"messages[i].num_media")
num_segments = CkJsonObject::ckStringOf(jResp,"messages[i].num_segments")
price = CkJsonObject::ckStringOf(jResp,"messages[i].price")
price_unit = CkJsonObject::ckStringOf(jResp,"messages[i].price_unit")
sid = CkJsonObject::ckStringOf(jResp,"messages[i].sid")
status = CkJsonObject::ckStringOf(jResp,"messages[i].status")
v_to = CkJsonObject::ckStringOf(jResp,"messages[i].to")
uri = CkJsonObject::ckStringOf(jResp,"messages[i].uri")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
CkDtObj::ckDispose(date_created)
CkDtObj::ckDispose(date_sent)
CkDtObj::ckDispose(date_updated)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "From=%7B%7BTWILIO_PHONE_NUMBER%7D%7D"
-u '{{TWILIO_ACCOUNT_SID}}:{{TWILIO_AUTH_TOKEN}}'
https://api.twilio.com/2010-04-01/Accounts/:AccountSid/Messages.json
Postman Collection Item JSON
{
"name": "List all messages sent from your Twilio number",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var template = `",
" <table bgcolor=\"#FFFFFF\">",
" <tr>",
" <th>To</th>",
" <th>Message Body</th>",
" <th>Sent at</th>",
" </tr>",
"",
" {{#each messages}}",
" <tr>",
" <td>{{to}}</td>",
" <td>{{body}}</td>",
" <td>{{date_sent}}</td>",
" </tr>",
" {{/each}}",
" </table>",
"`;",
"",
"// Set visualizer",
"pm.visualizer.set(template, {",
" // Pass the response body parsed as JSON as `data`",
" messages: pm.response.json().messages",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{TWILIO_AUTH_TOKEN}}",
"type": "string"
},
{
"key": "username",
"value": "{{TWILIO_ACCOUNT_SID}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{2010-04-01-Accounts-AccountSid-Messages.json-Url}}/2010-04-01/Accounts/:AccountSid/Messages.json?From={{TWILIO_PHONE_NUMBER}}",
"host": [
"{{2010-04-01-Accounts-AccountSid-Messages.json-Url}}"
],
"path": [
"2010-04-01",
"Accounts",
":AccountSid",
"Messages.json"
],
"query": [
{
"key": "To",
"value": "<string>",
"description": "Read messages sent to only this phone number.",
"disabled": true
},
{
"key": "From",
"value": "{{TWILIO_PHONE_NUMBER}}",
"description": "Read messages sent from only this phone number or alphanumeric sender ID."
},
{
"key": "DateSent",
"value": "<dateTime>",
"description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.",
"disabled": true
},
{
"key": "DateSent<",
"value": "<dateTime>",
"description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.",
"disabled": true
},
{
"key": "DateSent>",
"value": "<dateTime>",
"description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.",
"disabled": true
},
{
"key": "PageSize",
"value": "<integer>",
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"disabled": true
}
],
"variable": [
{
"key": "AccountSid",
"value": "{{TWILIO_ACCOUNT_SID}}",
"description": "(Required) The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read."
}
]
},
"description": "Retrieve a list of messages belonging to the account used to make the request. You can filter for example for only the messages that were sent from a specific phone number.\n\nRead more about it in the [Twilio Docs](https://www.twilio.com/docs/sms/api/message-resource#read-multiple-message-resources)"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{2010-04-01-Accounts-AccountSid-Messages.json-Url}}/2010-04-01/Accounts/:AccountSid/Messages.json?To=<string>&From=<string>&DateSent=<dateTime>&DateSent<=<dateTime>&DateSent>=<dateTime>&PageSize=<integer>",
"host": [
"{{2010-04-01-Accounts-AccountSid-Messages.json-Url}}"
],
"path": [
"2010-04-01",
"Accounts",
":AccountSid",
"Messages.json"
],
"query": [
{
"key": "To",
"value": "<string>"
},
{
"key": "From",
"value": "<string>"
},
{
"key": "DateSent",
"value": "<dateTime>"
},
{
"key": "DateSent<",
"value": "<dateTime>"
},
{
"key": "DateSent>",
"value": "<dateTime>"
},
{
"key": "PageSize",
"value": "<integer>"
}
],
"variable": [
{
"key": "AccountSid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"end\": 51142961,\n \"first_page_uri\": \"https://ZvltuXKxENEyvG.fnbzDIxrccIwHE6GxsyHjMd\",\n \"messages\": [\n {\n \"account_sid\": \"AC9E\",\n \"api_version\": \"commodo sint sunt eu\",\n \"body\": \"ut cillum\",\n \"date_created\": \"fugiat ipsum enim quis\",\n \"date_sent\": \"o\",\n \"date_updated\": \"laborum id esse elit\",\n \"direction\": \"outbound-reply\",\n \"error_code\": 89665305,\n \"error_message\": \"deserunt\",\n \"from\": \"anim esse\",\n \"messaging_service_sid\": \"MGC0\",\n \"num_media\": \"enim et\",\n \"num_segments\": \"quis qui ipsum\",\n \"price\": \"exercitation Duis\",\n \"price_unit\": \"consequat qu\",\n \"sid\": \"SMe5\",\n \"status\": \"scheduled\",\n \"subresource_uris\": {},\n \"to\": \"nulla\",\n \"uri\": \"cillum ut in irure\"\n },\n {\n \"account_sid\": \"ACD4\",\n \"api_version\": \"incididunt in non\",\n \"body\": \"deserunt incididunt irure eiusmod\",\n \"date_created\": \"sint ea\",\n \"date_sent\": \"Ut ut consectetur\",\n \"date_updated\": \"non dolore\",\n \"direction\": \"outbound-api\",\n \"error_code\": -69524035,\n \"error_message\": \"dolore Ut officia\",\n \"from\": \"reprehenderit\",\n \"messaging_service_sid\": \"MGEe\",\n \"num_media\": \"voluptate fugiat eiusmod qui Ut\",\n \"num_segments\": \"ea\",\n \"price\": \"consequat\",\n \"price_unit\": \"fugiat aliquip\",\n \"sid\": \"MM38\",\n \"status\": \"received\",\n \"subresource_uris\": {},\n \"to\": \"in tempor labore eiusmod\",\n \"uri\": \"elit non dol\"\n }\n ],\n \"next_page_uri\": \"http://fSikGpthYZQbOt.sncsPW4TzW44TkKnuDgx8f2FJz.\",\n \"page\": -43897926,\n \"page_size\": 12121047,\n \"previous_page_uri\": \"https://lSrGpSrECCMzKudcyRlwJdfhlnZEaAQ.hytgI,rCvOIy,x1C6vbgTvc9p6X2hkAdrqkd5jx8JKwJPiCrpsg2w\",\n \"start\": -23084704,\n \"uri\": \"https://USSzIQwA.hvxpmaT2476DlQGIi\"\n}"
}
]
}
