Skip to main content
When the internet path to a zone is not available, wede delivers through the channels assigned to your organisation (SMS, voice, satellite, LoRa or others), in the order you set. These endpoints let your administrators read what the organisation has and set that order without wede. The same view is the Communications page of the dashboard. You only ever see what is assigned to your organisation: each provider by its name, whether it is bought from wede or is your own API connected to wede, the price you pay (for channels bought from wede), the stock allocated for the year, this year’s usage and the usage above what your plan includes. Adding or removing a provider is done with wede.

​
Authentication

Session token (Authorization: Bearer <token>) of a company_admin or company_tech. Any other role, wede staff included, receives 403 forbidden. API keys are not accepted.

​
Read communications

Response 200
​
object[]
One entry per channel assigned to your organisation, in fallback order (channels not yet in the order come last).
​
boolean
true when the channel has at least one active provider in the order. A channel turned off is skipped.
​
integer
Seconds wede waits for a delivery on this channel before trying the next.
​
object[]
The providers assigned to your organisation for this channel: name, ownership (wede, bought from wede; own_api, your own provider connected to wede), verified (a real delivery already went through), in_cascade (part of the order), priority (position in the order), timeout_seconds, is_active, and price for providers bought from wede.
​
string
wede when the channel is bought from wede; own_provider when every provider of the channel is your own API, billed by your provider.
​
object | null
The price you pay per unit for channels bought from wede, as in Billing. null for channels billed by your own provider.
​
object | null
The stock allocated to your organisation for the year (allocated, used, remaining, source: plan or manual). null when nothing is allocated.
​
object
Events delivered through this channel this year (units) and, for SMS, the segments sent to field teams.
​
integer
Units included in your plan for the year.
​
object | null
Usage above what your plan includes (overage_units) and its amount at your price. null for channels billed by your own provider. estimate_total sums every channel. Usage above the plan is counted and shown here; it is not billed yet.

​
Set the fallback order

Replaces the order. Channels come in the order wede should try them; inside each channel, providers are integration ids in the order wede should try them. A channel with no providers leaves the order.
​
object[]
required
Up to 20 items, each with channel, providers (up to 10 integration ids assigned to your organisation for that channel), optional enabled (default true) and optional timeout_seconds (1 to 600, default 30).
Returns 200 with the same body as the read. New events follow the new order from then on. The change is written to the audit log.

​
Errors