Skip to content
Sendblue Docs
Get Started
API Reference

Location

Operations for sending and managing messages

List current shared locations
GET/api/location
Get one current shared location
GET/api/location/{number}
Watch one shared location
GET/api/location/{number}/watch
ModelsExpand Collapse
LocationListResponse object { from_number, locations, status }
from_number: optional string
locations: optional array of object { location, number, state }
location: optional object { accuracy, address, altitude, 6 more }
accuracy: optional number
address: optional string
altitude: optional number
expiresAt: optional string
latitude: optional number
locationType: optional "shallow" or "live" or "legacy" or "unknown"
One of the following:
"shallow"
"live"
"legacy"
"unknown"
longitude: optional number
refreshError: optional string

Present when cached data is returned after a refresh error

timestamp: optional string
number: optional string
state: optional "not_shared" or "shared_no_fix_yet" or "shared_with_fix"
One of the following:
"not_shared"
"shared_no_fix_yet"
"shared_with_fix"
status: optional "OK"
LocationRetrieveResponse object { from_number, location, number, 2 more }
from_number: optional string
location: optional object { accuracy, address, altitude, 6 more }
accuracy: optional number
address: optional string
altitude: optional number
expiresAt: optional string
latitude: optional number
locationType: optional "shallow" or "live" or "legacy" or "unknown"
One of the following:
"shallow"
"live"
"legacy"
"unknown"
longitude: optional number
refreshError: optional string

Present when cached data is returned after a refresh error

timestamp: optional string
number: optional string
state: optional "not_shared" or "shared_no_fix_yet" or "shared_with_fix"
One of the following:
"not_shared"
"shared_no_fix_yet"
"shared_with_fix"
status: optional "OK"
LocationWatchResponse object { from_number, location, message, 4 more }

JSON data payload from one named event in a live-location SSE stream

from_number: optional string

Sendblue line receiving the shared location

location: optional object { accuracy, address, altitude, 6 more }
accuracy: optional number
address: optional string
altitude: optional number
expiresAt: optional string
latitude: optional number
locationType: optional "shallow" or "live" or "legacy" or "unknown"
One of the following:
"shallow"
"live"
"legacy"
"unknown"
longitude: optional number
refreshError: optional string

Present when cached data is returned after a refresh error

timestamp: optional string
message: optional string

Human-readable watch failure

number: optional string

Contact whose location is being watched or changed

reason: optional string

Why the stream ended normally. Known values are sharing_ended, authorization_revoked, worker_disconnected, and watch_ended. Clients should tolerate additional values.

state: optional "not_shared" or "shared_no_fix_yet" or "shared_with_fix"
One of the following:
"not_shared"
"shared_no_fix_yet"
"shared_with_fix"
status: optional "OK" or "ERROR"
One of the following:
"OK"
"ERROR"