Txtreme SMS - Developer API 
  

DEVELOPER API FIELDS

(as at 4th Jun 2020)

 
Txtreme SMS - Developer API Fields
 
(Click on a field to jump down that fields help documentation)
 
  abe_id  ab_id  ab_name  acc_balance_units 
  addressbook_entry_abe_id  api_call_id  api_code  api_code_short 
  API_down_from  API_down_to  api_enabled  api_enabled_if_down 
  api_http_code  api_http_desc  api_id  api_id_to_set 
  api_key  api_key_to_set  api_param_divisor  api_param_field 
  api_param_format  api_param_io  api_param_length  api_param_min 
  api_param_optional  api_param_selection  api_param_seq  api_param_title 
  api_param_type  api_param_warning  API_status  API_status_txt 
  authorised  batch_id  bl_id  bl_name 
  bulk_list_send_id  calc_enough_units  calc_no_emails  calc_no_entries 
  calc_no_errors  calc_no_inter_SMS  calc_no_lines  calc_no_local_SMS 
  calc_no_pages  calc_no_SMS  calc_no_units  calc_no_valid 
  category_cat_id  category_name  charge  client_api_id 
  csv  date_from  date_to  email 
  entry_no  error_msg  firstname  first_name 
  fn  Http Return Code  international  key 
  lastname  last_name  level_id  level_name 
  line_no  list_entries  message  mobile 
  mobile_from  mobile_no  msg_callback_delivered  msg_callback_not_delivered 
  msg_callback_rejected  msg_callback_timeout  msg_id  msg_status 
  msg_status_received  msg_status_txt  name  NoResults 
  no_emails_sent  no_entries  no_errors  no_inter_SMS_sent 
  no_lines  no_local_SMS_sent  no_pages  no_pages_sent 
  no_SMS_sent  no_units  no_units_sent  no_valid 
  num  output  pwd  recipient 
  rec_id  ref  refunded_charge  ReturnApiKeyName 
  ReturnApiStatus  ReturnHTTP  ReturnMessage  send_email 
  status  status_date  status_lock_pin  time_received 
  time_sent  unit_cost  users_user_id  user_id 
  user_last_login  user_last_sent  user_name  valid 
  valid_until  vn  vn_major  vn_minor 
  vn_released    
     

 

 

 
FIELD: abe_id
 
DATABASE TABLE: addressbook_entry
 
 
 Primary/Unique key for the Addressbook entry - every contact saved in Txtreme's SMS System has an entry in this file pointed to by this key 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  
  MSG_LAST_CALC  MSG_LIST  MSG_LIST_FULL  

 
 

 
FIELD: ab_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: ab_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: acc_balance_units
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  AC_BAL_GET    

 
 

 
FIELD: addressbook_entry_abe_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  INBOX_LIST_FULL  INBOX_GET_FULL   

 
 

 
FIELD: api_call_id
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: api_code
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_ALL  FUNCTION_LIST  FUNCTION_VALID  
  FUNCTION_FIELDS  FUNCTION_HTTP  WEBSITE_SIGNIN  

 
 

 
FIELD: api_code_short
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_ALL  FUNCTION_LIST  FUNCTION_VALID  
  FUNCTION_FIELDS  FUNCTION_HTTP  WEBSITE_SIGNIN  

 
 

 
FIELD: API_down_from
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  API_VERSION   

 
 

 
FIELD: API_down_to
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  API_VERSION   

 
 

 
FIELD: api_enabled
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_ALL  FUNCTION_LIST  FUNCTION_VALID  

 
 

 
FIELD: api_enabled_if_down
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_ALL  FUNCTION_LIST  FUNCTION_VALID  

 
 

 
FIELD: api_http_code
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_HTTP    

 
 

 
FIELD: api_http_desc
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_HTTP    

 
 

 
FIELD: api_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_KEY_ENABLE  API_KEY_SUSPEND  API_KEY_LOCK  
  API_KEY_UNLOCK    

 
 

 
FIELD: api_id_to_set
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_KEY_ENABLE  API_KEY_SUSPEND   

 
 

 
FIELD: api_key
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_KEY_ENABLE  API_KEY_SUSPEND  API_KEY_LOCK  
  API_KEY_UNLOCK    

 
 

 
FIELD: api_key_to_set
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_KEY_ENABLE  API_KEY_SUSPEND   

 
 

 
FIELD: api_param_divisor
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_field
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_format
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_io
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_length
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_min
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_optional
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_selection
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_seq
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_title
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_type
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: api_param_warning
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_FIELDS    

 
 

 
FIELD: API_status
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  API_VERSION   

 
 

 
FIELD: API_status_txt
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  API_VERSION   

 
 

 
FIELD: authorised
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  FUNCTION_ALL  FUNCTION_LIST  FUNCTION_VALID  

 
 

 
FIELD: batch_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  
  MSG_LIST  MSG_LIST_FULL  MSG_GET_FULL  

 
 

 
FIELD: bl_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: bl_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: bulk_list_send_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_FULL  

 
 

 
FIELD: calc_enough_units
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_emails
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_entries
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK_CALC  MSG_MULTI_CALC  MSG_MULTI_ONE_CALC  
  MSG_CSV_CALC    

 
 

 
FIELD: calc_no_errors
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_BULK_CALC  
  MSG_MULTI_CALC  MSG_MULTI_ONE_CALC  MSG_CSV_CALC  

 
 

 
FIELD: calc_no_inter_SMS
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_lines
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_MULTI_CALC  MSG_MULTI_ONE_CALC  MSG_CSV_CALC  

 
 

 
FIELD: calc_no_local_SMS
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_pages
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_SMS
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC    

 
 

 
FIELD: calc_no_units
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_CALC  MSG_BULK_CALC  MSG_MULTI_CALC  
  MSG_MULTI_ONE_CALC  MSG_CSV_CALC   

 
 

 
FIELD: calc_no_valid
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_BULK_CALC  
  MSG_MULTI_CALC  MSG_MULTI_ONE_CALC  MSG_CSV_CALC  

 
 

 
FIELD: category_cat_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: category_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: charge
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_FULL    

 
 

 
FIELD: client_api_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  API_VERSION  MSG_LIST  
  MSG_LIST_FULL  INBOX_LIST_FULL  INBOX_GET_FULL  

 
 

 
FIELD: csv
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  

 
 

 
FIELD: date_from
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  INBOX_LIST_FULL  

 
 

 
FIELD: date_to
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  INBOX_LIST_FULL  

 
 

 
FIELD: email
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV_LIST    

 
 

 
FIELD: entry_no
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_ONE  
  MSG_MULTI_ONE_CALC  MSG_CSV  MSG_CSV_CALC  
  MSG_LAST_CALC    

 
 

 
FIELD: error_msg
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  
  MSG_LAST_CALC  MSG_LIST   

 
 

 
FIELD: firstname
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_GET    

 
 

 
FIELD: first_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST  MSG_LIST  
  MSG_LIST_FULL  MSG_GET_FULL   

 
 

 
FIELD: fn
 
 Sorry, No help text available at this time. 
 
*** Master INPUT field, used in all functions ***

 
 

 
FIELD: Http Return Code
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: international
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST   

 
 

 
FIELD: key
 
 Sorry, No help text available at this time. 
 
*** Master INPUT field, used in all functions ***

 
 

 
FIELD: lastname
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_GET    

 
 

 
FIELD: last_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST  MSG_LIST  
  MSG_LIST_FULL  MSG_GET_FULL   

 
 

 
FIELD: level_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_SEC_LEVELS  API_KEY_LEVELS   

 
 

 
FIELD: level_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_SEC_LEVELS  API_KEY_LEVELS   

 
 

 
FIELD: line_no
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions (with repeating entries) ***

 
 

 
FIELD: list_entries
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_BULK_CALC  MSG_MULTI  
  MSG_MULTI_CALC  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  
  MSG_CSV  MSG_CSV_CALC  MSG_LAST_CALC  

 
 

 
FIELD: message
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  
  MSG_LIST_FULL  MSG_GET_FULL  INBOX_LIST_FULL  
  INBOX_GET_FULL    

 
 

 
FIELD: mobile
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST   

 
 

 
FIELD: mobile_from
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  INBOX_LIST_FULL  INBOX_GET_FULL   

 
 

 
FIELD: mobile_no
 
DATABASE TABLE: addressbook_entry
 
 
 Specifies a mobile number to send SMS message to - this is also used to match to a unique entry in the 'addressbook_entry' table - this gives access to a stored contact name and email address from the addressbook (if present, if the Client key parameter is set then the addressbook_entry either must esist to send or not
 
the format of this field is full international number, e.g. 447968141999 (but +44796814199 & 07968141999 will also work)
 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_LAST_CALC  
  MSG_LIST  MSG_LIST_FULL   

 
 

 
FIELD: msg_callback_delivered
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_STATUS  MSG_GET_FULL   

 
 

 
FIELD: msg_callback_not_delivered
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_STATUS  MSG_GET_FULL   

 
 

 
FIELD: msg_callback_rejected
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_STATUS  MSG_GET_FULL   

 
 

 
FIELD: msg_callback_timeout
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_STATUS  MSG_GET_FULL   

 
 

 
FIELD: msg_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  
  MSG_LIST  MSG_LIST_FULL  MSG_GET_STATUS  
  MSG_GET_FULL  INBOX_LIST_FULL  INBOX_GET_FULL  

 
 

 
FIELD: msg_status
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_STATUS  MSG_GET_FULL   

 
 

 
FIELD: msg_status_received
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_STATUS  
  MSG_GET_FULL    

 
 

 
FIELD: msg_status_txt
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_STATUS  
  MSG_GET_FULL    

 
 

 
FIELD: name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  
  MSG_LAST_CALC    

 
 

 
FIELD: NoResults
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: no_emails_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_entries
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_MULTI  MSG_MULTI_ONE  
  MSG_CSV  MSG_LAST_CALC   

 
 

 
FIELD: no_errors
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_MULTI  MSG_MULTI_ONE  
  MSG_CSV  MSG_LAST_CALC   

 
 

 
FIELD: no_inter_SMS_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_lines
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_MULTI  MSG_MULTI_ONE  MSG_CSV  
  MSG_LAST_CALC    

 
 

 
FIELD: no_local_SMS_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_pages
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST   

 
 

 
FIELD: no_pages_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_SMS_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_units
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST   

 
 

 
FIELD: no_units_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_BULK  MSG_MULTI  
  MSG_MULTI_ONE  MSG_CSV  MSG_LAST_CALC  

 
 

 
FIELD: no_valid
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_BULK  MSG_MULTI  MSG_MULTI_ONE  
  MSG_CSV  MSG_LAST_CALC   

 
 

 
FIELD: num
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  

 
 

 
FIELD: output
 
 Sorry, No help text available at this time. 
 
*** Master INPUT field, used in all functions ***

 
 

 
FIELD: pwd
 
 Sorry, No help text available at this time. 
 
*** Master INPUT field, used in all functions ***

 
 

 
FIELD: recipient
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_FULL  

 
 

 
FIELD: rec_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  INBOX_LIST_FULL  INBOX_GET_FULL   

 
 

 
FIELD: ref
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND  MSG_SEND_CALC  MSG_SEND_LIST  
  MSG_BULK  MSG_BULK_CALC  MSG_BULK_LIST  
  MSG_MULTI  MSG_MULTI_CALC  MSG_MULTI_LIST  
  MSG_MULTI_ONE  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  
  MSG_CSV  MSG_CSV_CALC  MSG_CSV_LIST  
  MSG_LAST_CALC    

 
 

 
FIELD: refunded_charge
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_GET_FULL    

 
 

 
FIELD: ReturnApiKeyName
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: ReturnApiStatus
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: ReturnHTTP
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: ReturnMessage
 
 Sorry, No help text available at this time. 
 
*** Master OUTPUT field, used in all functions ***

 
 

 
FIELD: send_email
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_SEND_LIST  MSG_BULK_LIST  MSG_MULTI_LIST  
  MSG_MULTI_ONE_LIST  MSG_CSV_LIST   

 
 

 
FIELD: status
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_GET  API_KEY_ENABLE  API_KEY_SUSPEND  
  API_KEY_LOCK  API_KEY_UNLOCK   

 
 

 
FIELD: status_date
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_STATUS  
  MSG_GET_FULL    

 
 

 
FIELD: status_lock_pin
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_KEY_LOCK  API_KEY_UNLOCK   

 
 

 
FIELD: time_received
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  INBOX_LIST_FULL  INBOX_GET_FULL   

 
 

 
FIELD: time_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL  MSG_GET_STATUS  
  MSG_GET_FULL  INBOX_LIST_FULL  INBOX_GET_FULL  

 
 

 
FIELD: unit_cost
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  AC_BAL_GET    

 
 

 
FIELD: users_user_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  MSG_LIST  MSG_LIST_FULL   

 
 

 
FIELD: user_id
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_LIST  USER_GET   

 
 

 
FIELD: user_last_login
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_GET    

 
 

 
FIELD: user_last_sent
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_GET    

 
 

 
FIELD: user_name
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  USER_LIST  USER_GET   

 
 

 
FIELD: valid
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY  FUNCTION_VALID  MSG_SEND  
  MSG_SEND_CALC  MSG_SEND_LIST  MSG_BULK  
  MSG_BULK_CALC  MSG_BULK_LIST  MSG_MULTI  
  MSG_MULTI_CALC  MSG_MULTI_LIST  MSG_MULTI_ONE  
  MSG_MULTI_ONE_CALC  MSG_MULTI_ONE_LIST  MSG_CSV  
  MSG_CSV_CALC  MSG_CSV_LIST  MSG_LAST_CALC  

 
 

 
FIELD: valid_until
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  TEST_KEY    

 
 

 
FIELD: vn
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_VERSION    

 
 

 
FIELD: vn_major
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_VERSION    

 
 

 
FIELD: vn_minor
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_VERSION    

 
 

 
FIELD: vn_released
 
 Sorry, No help text available at this time. 
 
USED IN THE FOLLOWING FUNCTIONS
 
  API_VERSION    

 

 

Txtreme SMS - Developer API Database Schema 1/2

 

Txtreme SMS - Developer API Database Schema 2/2