FireFlo OMNI

What a call can be placed into: your published IVRs, and — on your own Voice organisation — your voice agents. Pass one as target to POST /v1/calls. unavailable is true when Voice can’t be asked right now; an account without Voice gets an empty list.

Needs the calls:read scope.

Request

curl https://api.fireflo.au/v1/calls/targets \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/calls/targets",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/calls/targets", {
  headers: {
    Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
  },
});
console.log(response.status, await response.json());

Response

200 OK

{
  "data": [
    {
      "type": "ivr",
      "id": "4471",
      "name": "Delivery confirmation"
    },
    {
      "type": "voice_agent",
      "id": "88",
      "name": "Appointment reminder"
    }
  ],
  "unavailable": false
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
403	`scope_missing`	The key doesn’t have the `calls:read` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.