R/tw.messages.R

In workingamerica/twilio: Working America Useful Functions

# latest messages ---------------------------------------------------------

#' Twilio Spoke API: Latest Messages
#' 
#' @keywords twilio sms spoke api
#' @export tw.messages.list
#' 
#' @usage tw.messages.list(
#'   sid = Sys.getenv('TWILIO_ACCOUNT_SID'),
#'   key = Sys.getenv('TWILIO_KEY'),
#'   secret = Sys.getenv('TWILIO_SECRET'),
#'   from = NA, 
#'   to = NA, 
#'   datesent = NA, 
#'   n = 20, 
#'   verbose = FALSE
#' )
#' 
#' @param sid twilio credentials: Account SID.
#' @param key twilio credentials: Account user key.
#' @param secret twilio credentials: User secret. Don't store this in scripts!!!
#' @param n number of records to return, for API calls that return more than one record.
#' @param from number a message was sent from
#' @param to number a message was sent to
#' @param datesent date a message was sent, 'YYYY-MM-DD' format
#' @param verbose Print detailed progress.
#' 
#' @section Details:
#' ?
#' 
#' @examples
#' 
#' \dontrun{
#' source("C:/Users/lwolberg/Desktop/.ssh/twilio_auth.R")
#' 
#' tw.messages.list(sid, token, n=20, from='19202893705')
#' }

tw.messages.list <- function(
  sid = Sys.getenv('TWILIO_ACCOUNT_SID'),
  key = Sys.getenv('TWILIO_KEY'),
  secret = Sys.getenv('TWILIO_SECRET'),
  from = NA,
  to = NA,
  datesent = NA,
  n = 20,
  verbose = FALSE
) {
  ## check for/create auth token:
  auth <- tw.auth(sid=key,token=secret)
  if(is.na(sid)) sid <- Sys.getenv('TWILIO_ACCOUNT_SID')
  
  # curl -X GET 'https://api.twilio.com/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  # /Messages.json?
  # DateSent=2016-08-31T00%3A00%3A00Z
  # &From=%2B15017122661
  # &To=%2B15558675310
  # &PageSize=20'
  
  u <- paste0(
    'https://api.twilio.com/2010-04-01/Accounts/',sid,'/Messages.json'
  )
  ## query vars for end of URL.
  qvars <- list()
  # looks like httr::POST() already does urlencode, so no need to duplicate.
  if(!is.na(datesent)) { qvars$DateSent <- datesent }
  if(!is.na(from)) { qvars$From <- from }
  if(!is.na(to)) { qvars$To <- to }
  if(!is.na(n)) { qvars$PageSize <- n }
  if(verbose) print(qvars)
  
  resp <- httr::GET( url = u, query = qvars, auth )
  if(verbose) print(resp)
  
  ## handle errors and etc:
  parsed <- tw.httr(resp, simplifyDataFrame = TRUE)
  # print(summary(parsed))
  
  # save only $messages, and return as a data.table
  parsed <- data.table::as.data.table(parsed$messages)
  
  return(parsed)
}