Chilkat Online Tools

Swift3 / Twilio Messaging / SMS / List all messages sent from your Twilio number

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{TWILIO_ACCOUNT_SID}}"
    http.password = "{{TWILIO_AUTH_TOKEN}}"

    let queryParams = CkoJsonObject()!
    queryParams.update("From", value: "{{TWILIO_PHONE_NUMBER}}")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.twilio.com/2010-04-01/Accounts/:AccountSid/Messages.json", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    let date_created = CkoDtObj()!
    let date_sent = CkoDtObj()!
    let date_updated = CkoDtObj()!
    var account_sid: String?
    var api_version: String?
    var body: String?
    var direction: String?
    var error_code: Int
    var error_message: String?
    var from: String?
    var messaging_service_sid: String?
    var num_media: String?
    var num_segments: String?
    var price: String?
    var price_unit: String?
    var sid: String?
    var status: String?
    var v_to: String?

    var v_end: Int = jResp.int(of: "end").intValue
    var first_page_uri: String? = jResp.string(of: "first_page_uri")
    var next_page_uri: String? = jResp.string(of: "next_page_uri")
    var page: Int = jResp.int(of: "page").intValue
    var page_size: Int = jResp.int(of: "page_size").intValue
    var previous_page_uri: String? = jResp.string(of: "previous_page_uri")
    var start: Int = jResp.int(of: "start").intValue
    var uri: String? = jResp.string(of: "uri")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "messages").intValue
    while i < count_i {
        jResp.i = i
        account_sid = jResp.string(of: "messages[i].account_sid")
        api_version = jResp.string(of: "messages[i].api_version")
        body = jResp.string(of: "messages[i].body")
        jResp.dt(of: "messages[i].date_created", bLocal: false, dt: date_created)
        jResp.dt(of: "messages[i].date_sent", bLocal: false, dt: date_sent)
        jResp.dt(of: "messages[i].date_updated", bLocal: false, dt: date_updated)
        direction = jResp.string(of: "messages[i].direction")
        error_code = jResp.int(of: "messages[i].error_code").intValue
        error_message = jResp.string(of: "messages[i].error_message")
        from = jResp.string(of: "messages[i].from")
        messaging_service_sid = jResp.string(of: "messages[i].messaging_service_sid")
        num_media = jResp.string(of: "messages[i].num_media")
        num_segments = jResp.string(of: "messages[i].num_segments")
        price = jResp.string(of: "messages[i].price")
        price_unit = jResp.string(of: "messages[i].price_unit")
        sid = jResp.string(of: "messages[i].sid")
        status = jResp.string(of: "messages[i].status")
        v_to = jResp.string(of: "messages[i].to")
        uri = jResp.string(of: "messages[i].uri")
        i = i + 1
    }


}

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}"
    }
  ]
}