PhoneMacro

Queue a phone macro

POST

https://0bull.net/api

/v1/phones/{slot}/macros

Runs a named workflow or a list of steps, and returns a run record right away. Poll GET /v1/phones/{slot}/runs/{run} to see it finish.

Queue a phone macro › path Parameters

slot

string · required

Queue a phone macro › Request Body

PhoneMacroRequest

workflow

string | null

object | null

Named scalar values for the workflow's {{placeholders}}.

array | null · maxItems: 200

Queue a phone macro › Responses

PhoneRunResource

PhoneRunResource · required

POST/v1/phones/{slot}/macros

curl https://0bull.net/api/v1/phones/:slot/macros \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workflow": "workflow",
  "params": {
    "key": "string"
  },
  "steps": [
    {
      "action": "action"
    }
  ]
}'

Example Request Body

{
  "workflow": "workflow",
  "params": {
    "key": "string"
  },
  "steps": [
    {
      "action": "action"
    }
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "slot": "slot",
    "kind": "kind",
    "status": "status",
    "label": "label",
    "result": {
      "key": {}
    },
    "error": "error",
    "started_at": "started_at",
    "finished_at": "finished_at",
    "created_at": "created_at"
  }
}

json

application/json

PhoneInput PhoneRun

0bull API

PhoneMacro

Queue a phone macro

POST

https://0bull.net/api

/v1/phones/{slot}/macros

Runs a named workflow or a list of steps, and returns a run record right away. Poll GET /v1/phones/{slot}/runs/{run} to see it finish.

Queue a phone macro › path Parameters

slot

string · required

Queue a phone macro › Request Body

PhoneMacroRequest

workflow

string | null

object | null

Named scalar values for the workflow's {{placeholders}}.

array | null · maxItems: 200

Queue a phone macro › Responses

PhoneRunResource

PhoneRunResource · required

POST/v1/phones/{slot}/macros

curl https://0bull.net/api/v1/phones/:slot/macros \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workflow": "workflow",
  "params": {
    "key": "string"
  },
  "steps": [
    {
      "action": "action"
    }
  ]
}'

Example Request Body

{
  "workflow": "workflow",
  "params": {
    "key": "string"
  },
  "steps": [
    {
      "action": "action"
    }
  ]
}

json

Example Responses

{
  "data": {
    "id": "id",
    "slot": "slot",
    "kind": "kind",
    "status": "status",
    "label": "label",
    "result": {
      "key": {}
    },
    "error": "error",
    "started_at": "started_at",
    "finished_at": "finished_at",
    "created_at": "created_at"
  }
}

json

application/json

PhoneInput PhoneRun