class Telerivet::Route
Represents a custom route that can be used to send messages via one or more basic routes (phones).
Custom Routes were formerly referred to simply as “Routes” within Telerivet
. API
methods, parameters, and properties related to Custom Routes continue to use the term “Route” to maintain backwards compatibility.
Custom routing rules can currently only be configured via Telerivet's web UI.
Fields:
- id (string, max 34 characters) * Telerivet's internal ID for the route * Read-only - name * The name of the route * Updatable via API - vars (Hash) * Custom variables stored for this route * Updatable via API - project_id * ID of the project this route belongs to * Read-only
Public Instance Methods
get_base_api_path()
click to toggle source
# File lib/telerivet/route.rb, line 57 def get_base_api_path() "/projects/#{get('project_id')}/routes/#{get('id')}" end
id()
click to toggle source
# File lib/telerivet/route.rb, line 41 def id get('id') end
name()
click to toggle source
# File lib/telerivet/route.rb, line 45 def name get('name') end
name=(value)
click to toggle source
# File lib/telerivet/route.rb, line 49 def name=(value) set('name', value) end
project_id()
click to toggle source
# File lib/telerivet/route.rb, line 53 def project_id get('project_id') end
save()
click to toggle source
Saves any fields or custom variables that have changed for this route.
Calls superclass method
Telerivet::Entity#save
# File lib/telerivet/route.rb, line 37 def save() super end