Skip to main content
GET
Get the configuration of a line
  • Credential: an API key of the owner of the line. The operation works on any line you own. See Configuration.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list.
  • Events: none.
  • Defaults: read them from knobs, from default_activity_curve and from config. They depend on the line, and iSnap can change them. What each setting does is in Sending limits.
  • Sending hours: config.activity_curve is the curve of the line, never empty: its override, or default_activity_curve. On a shared line, the curve of the number that serves the contact applies to the sends instead: see Quiet hours.
  • Bounds: of the eight limits in knobs, only the five message limits of a BYOD line accept a value above default, up to knobs.<key>.max. For the three reply limits, and for the five message limits of a line that is not a BYOD line, PATCH /v1/lines/{id}/config returns 403 cannot_increase_limit for a value above default and up to max. For each key, a value outside min to max is refused before that check, on every line: with 422 limit_out_of_bounds or 400 validation_failed. The two spacing settings can only be raised: a value below default returns 403 cannot_decrease_delay.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Response

The configuration of the line.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The sending configuration of a line.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.