get_paginated_mdrs: Fetch messaging detail records

In CannabisMDA/telnyxr: An Interface to the Telnyx API for R

Description

Fetch all Mdr records.

Usage

get_paginated_mdrs(
  start_date,
  end_date,
  page_number = 1,
  page_size = 20,
  sort = c("created_at"),
  id = NULL,
  direction = NULL,
  outbound_profile_id = NULL,
  cld = NULL,
  cli = NULL,
  status = NULL,
  message_type = NULL,
  country_iso = NULL,
  error = NULL,
  normalized_carrier = NULL,
  tag = NULL,
  mcc = NULL,
  mnc = NULL,
  product = NULL
)

Arguments

start_date	date-time Start date. Example: Sys.time()
end_date	date-time End date. Example: Sys.time()
page_number	integer (1) Page number.
page_size	integer (1 - 50) Size of the page.
sort	array of string Field used to order the data. Example: "created_at"
id	string Message uuid. Example: "e093fbe0-5bde-11eb-ae93-0242ac130002"
direction	string Options: ["INBOUND", "OUTBOUND"]
outbound_profile_id	string Configured profile id. New profiles can be created and configured on Telnyx portal. Example: "30ef55db-c4a2-4c4a-9804-a68077973d07"
cld	string Destination number. Example: "[phone]"
cli	string Origination number. Example: "[phone]"
status	string Message status. Options: ["GW_TIMEOUT", "DELIVERED", "DLR_UNCONFIRMED", "DLR_TIMEOUT", "RECEIVED", "GW_REJECT", "FAILED"]
message_type	string type of the message. Default: "text". Options: ["audio", "contacts", "document", "hsm", "image", "location", "template", "text", "video", "voice", "unknown"]
country_iso	string Destination number ISO country code. Example: "US"
error	string Reported error code. Example: "40001"
normalized_carrier	string Carrier. Example: "Verizon"
tag	string Specified tag. Example: "Tag1"
mcc	string Mobile country code. Example: "204"
mnc	string Mobile network code. Example: "01"
product	string Used product. Options: ["LONG_CODE", "SHORT_CODE", "SHORT_CODE_FTEU", "TOLL_FREE", "ALPHANUMERIC_ID", "RCS"]

CannabisMDA/telnyxr documentation built on Dec. 17, 2021, 1:56 p.m.