This page has been replaced by our new Help pages at tellustalk.com
Properties of TellusTalk customers and users
Many params can be set at customer level, these will be used unless override on user level.
Authorization limits what values are available (eg, a basic user can not Get or Post customer level settings)
Structure for /customers/v1: (Response is list of dicts: [{}, ...])
{ id, name, ...,
organization: [{ id, level, name, invoice_code...}, ...] -- Structure for billing_id groups (hierarchy by level)
billing_id_settings: { id: { SMS and Fax settings etc... }, id: ...} -- Settings for a particular billing_id group of users
default_billing_id_settings: { id: { fax/sms settings... }, id: ...} -- Default settings merged from customer and billing_id hierarchy
}
billing_id=0 is top level and always available (also for customers that don't use organization tree to manage user settings)
Structure for /users/v1: (Response is list of dicts: [{}, ...])
{ id, name, customer_id, billing_id, ...}
If a value is not set on user, it can be fetched from /customers/v1 (by user's customer_id),
property default_billing_id_settings indexed by user's billing_id.
Some of these values can be set per request to application /send/v1.
sms_flash
sms_max_parts
sms_message_end_list -- List of texts removed from Email when sending SMS (Eg company email footer, etc)
sms_signature -- text always appended to SMS messages
sms_originator_source -- options: [ reply_sms | number | shortcode | subject | text ]
sms_originator_number
sms_originator_text
fax_report_recipients -- List of dicts: [{}, ....] with following params
sms_report_recipients
sms_reply_recipients
address: see API Address Format
send_report -- options: [ always | never | delivered_only | failed_only | supplier_changed ]
(supplier_changed option: report always, also intermediate progress reports)
include_original -- Include original message, in SMS/Fax reports.
send_commands -- Report group subscription actions.
fax_coverpages = { id: { name, active } ...} -- customer param, any coverpage for any user
Per billing group, or per user:
fax_coverpage_id -- the fax_coverpages id, -1 standard coverpage, 0 no fax coverpage
fax_coverpage_name
fax_coverpage_address
fax_coverpage_company_name
fax_coverpage_fax_number
fax_coverpage_fax_international_number
fax_coverpage_phone_number
fax_coverpage_international_number
fax_coverpage_postcode
fax_coverpage_city
Used for non-customer/non-users:
alien_spam
alien_fax_count
alien_fax_limit
alien_sms_count
alien_sms_limit