Lines

Read a shared location

Requires comms_read and access to the dedicated line. Returns a contact location only while they are sharing it with this number. Unsupported lines return 409. Responses are not cached.

get/lines/{id}/location

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/lines/{id}/location
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

fromstring required

Contact E.164 phone number; encode the plus sign as %2B.

Response

Current sharing status and latest available shared point.

line_idstring required
line_e164string required
fromstring required

The contact sharing their location.

versioninteger required
status'sharing' | 'stopped' | 'expired' | 'not_shared' | 'unavailable' required
checked_atstring date-time required
shared_atstring date-time nullable required
expires_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.