app2email API Pryse

Dokumentasie

Submit-Info

Die gids vir Submit-Info: bou 'n vorm uit 'n lys vrae, publiseer dit na WhatsApp en 'n webblad, werk indienings deur fases in 'n gedeelde inkassie met rolle, outomatiseer antwoorde en roepings na jou eie stelsels, en stel alles op via die API of 'n KI-agent.

Jy skryf 'n vorm as 'n gewone lys vrae. app2email maak dit 'n vorm binne WhatsApp en 'n webblad met dieselfde stappe. 'n Kliënt, of 'n lid van jou eie veldspan, vul dit in en kry 'n verwysing. Die antwoorde en lêers word 'n indiening in 'n gedeelde inkassie, waar dit deur jou fases beweeg en jou outomatiserings aan die gang sit.

Een idee

Vorm, dan indiening, dan fases, dan outomatiserings, dan verbindings. 'n Versoek vir 'n kwotasie, 'n aansoek, 'n meterlesing, 'n probleemverslag, 'n voltooide werk, 'n afleweringsbewys en 'n uitgawekwitansie is almal dieselfde ding met verskillende vrae en verskillende fasename. Elkeen kom as 'n sjabloon wat jy kan installeer en verander.

Begin in vyf minute

  1. Maak dit oop: maak in jou dashboard die Submit-Info-bladsy oop (/dashboard/app/submit, ook oopgemaak vanaf Integrations). Skakel dit aan.
  2. Maak 'n vorm: kies "New form" en kies 'n sjabloon, of begin leeg. Gee dit 'n naam en skryf jou vrae. Elke vraag is een ry: die teks, die tipe, en of dit beantwoord moet word.
  3. Publiseer: "Publish to WhatsApp" laai die vorm op WhatsApp op en maak dit lewendig. Die webblad met dieselfde stappe is dadelik lewendig.
  4. Deel: onder Share vind jy die woord wat die vorm in jou klets oopmaak, 'n skakel wat jou klets oopmaak met daardie woord reeds getik, die webblad se adres, 'n QR-kode, en 'n snippet om die vorm op jou eie webwerf te plaas.
  5. Werk die inkassie: nuwe indienings kom in die Inbox aan. Maak een oop, verander die fase, antwoord. Nooi jou span uit wanneer jy gereed is.

Niks verander vir 'n nommer wat nooit Submit-Info oopmaak nie. 'n Vorm wat nog nie na WhatsApp gepubliseer is nie, werk steeds: sy woord antwoord met die webblad se skakel.

Die vormbouer

'n Vorm het 1 tot 12 stappe, en 'n stap het 'n titel en 1 tot 12 vrae. Daar is geen doek en niks om te teken nie: dieselfde lys dryf die vorm op WhatsApp, die webblad, die kontroles op die antwoorde, die kolomme van die tabelaansig, die uitvoere en die API. Die voorskou langs die redigeerder wys die vorm soos 'n persoon dit sien.

TipeWat die persoon geeWat jy kan instel
text'n Kort antwoordkortste en langste lengte, 'n patroon
textarea'n Langer antwoordkortste en langste lengte
number'n Getallaagste en hoogste waarde, desimale, 'n eenheid soos kWh
email'n E-posadres
phone'n Telefoonnommer
date'n Datumhoeveel dae terug of vooruit dit mag wees
selectEen keusedie keuses (2 tot 200), of 'n lys van jou eie
multiselectVerskeie keusesdie keuses (2 tot 20), die minste en die meeste om te merk
yesnoJa of Nee
rating'n Punt van 1 tot 3-10die hoogste punt
consent'n Sin om mee in te stemof dit gemerk moet word
photoEen of meer foto'shoeveel (1 tot 10); kamera, galery of albei
documentEen of meer lêershoeveel (1 tot 10); enige lêer, PDF, prente of kantoorlêers
locationWaar die persoon isop WhatsApp die liggingsversoek; op die web 'n knoppie en 'n adreslyn
infoTeks wat jy wysniks word gevra of gestoor nie
hidden'n Waarde wat met die skakel saamkomsoos 'n werknommer; niks word gewys nie
  • Hulpteks en verstekwaardes: elke vraag kan 'n kort wenk en 'n verstekwaarde dra. 'n Verstek kan gebruik wat jy reeds weet, soos {contact.name}.
  • Wys net wanneer: 'n stap of 'n vraag kan van 'n vroeëre antwoord afhang ("wys hierdie stap net wanneer Problem Ja is"). WhatsApp en die webblad volg dieselfde reël.
  • Interne velde: velde wat nooit gevra word nie. Jou span of 'n outomatisering vul dit in: 'n kwotasiebedrag, 'n besluitrede, 'n id wat van 'n ander stelsel teruggekom het. Hulle wys net in die inkassie en in uitvoere.
  • Lyste: 'n keuse-vraag kan sy keuses uit 'n lys van jou eie neem (terreine, werke, produkte met pryse). Verander die lys in die dashboard of deur die API en die vorm volg, sonder om weer te publiseer.
  • Berekende waardes: 'n formule oor die antwoorde, vir 'n onmiddellike beraming of 'n kontrole. Sien formules.
  • Na die stuur: 'n hersieningskerm voor die stuur, die antwoord met die verwysing, 'n "Add more"-knoppie wat die volgende boodskappe (teks, foto's, lêers) vir tien minute by die indiening voeg, en die skakel na die persoon se eie statusbladsy.
  • Publisering: app2email skryf die WhatsApp-vorm vir jou, verdeel 'n lang stap oor verskeie skerms wanneer WhatsApp se limiete dit vra, en hou die laaste vyf gepubliseerde weergawes sodat 'n ouer boodskap steeds die vorm oopmaak waarmee dit gestuur is.

Die webblad. Dieselfde stappe by /form/your-code/form-key. Dit vra eers 'n naam en laaste 'n WhatsApp-nommer. Ná die stuur sien die persoon die verwysing en kan hulle "Get updates on WhatsApp" tik, wat hul nommer met een boodskap bevestig; 'n vorm kan so ingestel word dat dit dit vereis. 'n Persoonlike skakel (wat jy stuur) weet reeds wie die persoon is. Om die vorm op jou eie webwerf te plaas, gebruik die snippet onder Share; as die vorm 'n ligging vra, voeg allow="geolocation" by die iframe. Foto's word kleiner gemaak in die blaaier voordat hulle opgelaai word; 'n lêer kan tot 10 MB wees.

Hoe mense 'n vorm bereik

  • 'n Woord: elke vorm het sy eie woorde. Die woorde form, forms, report en submit (jy kan hulle verander) lys jou vorms as 'n kieslys wanneer daar verskeie is. 'n Woord tel net in 'n kort boodskap: een met minder as 10 ander woorde (Settings, "Ignore the words in long messages"), so 'n lang boodskap wat dit toevallig bevat, begin niks nie.
  • 'n Skakel of 'n QR-kode: 'n skakel wat jou WhatsApp-klets met die vorm se woord oopmaak, of die webblad se adres.
  • Deur jou gestuur: "Send form" in die inkassie, of die API, stuur 'n vorm na een nommer, met waardes reeds ingevul ('n werknommer, 'n rekening, die dokumente wat jy wil hê).
  • 'n Opvolging: 'n outomatisering of 'n spanlid vra vir meer met 'n tweede vorm. Wat terugkom, word aan die eerste indiening geheg.
  • Die webblad, en die API vir stelsels wat die data reeds het.

Wie mag stuur. Enigeen (die gewone keuse), of net die nommers wat jy lys, of kontakte met 'n etiket van jou. Só bly 'n vorm by jou veldspan. Die woord status antwoord 'n persoon met die fase van hul onlangse indienings.

Fases

Fases behoort aan die vorm. 'n Nuwe vorm begin met New, In progress en Done; hernoem hulle, voeg jou eie by (2 tot 12), en kies 'n kleur. Elke fase is een van drie soorte: oop, klaar of gekanselleer.

  • Wie mag dit kies: hou 'n fase vir sekere rolle. 'n Agent berei voor, net 'n Bestuurder keur goed.
  • Notas word vereis: vra vir 'n rede wanneer 'n indiening daarheen geskuif word (afgekeur, verwerp, navraag).
  • Boodskap: 'n teks wat na die persoon gestuur word wanneer hul indiening die fase bereik, met plekhouers.
  • Knoppies vir die persoon: 'n antwoord kan tot drie knoppies dra (Accept, Decline, "Not fixed yet"), en elkeen skuif die fase. Dié een stuk gee jou kwotasie-aanvaarding, bevestiging van 'n besoek en "is dit reg?".

'n Antwoord wat buite WhatsApp se antwoordtyd geskryf is, word bewaar en afgelewer wanneer die persoon volgende skryf. Die inkassie sê so op die antwoord.

Die inkassie en rolle

Die Inbox wys Open, Mine, Unassigned, Done en All, plus die aansigte wat jy stoor. Soek en filtreer volgens vorm, fase, toegewese persoon, etiket, kanaal en datum. Drie uitlegte: 'n lys, 'n tabel (een vorm: elke vraag is 'n kolom) en 'n bord (een vorm: 'n kolom vir elke fase). Merk verskeie rye om die fase te verander, toe te wys, etiketteer, uit te voer of uit te vee, almal saam.

'n Indiening wys sy antwoorde, sy lêers, waarvandaan dit gestuur is, en een geskiedenis van alles wat daarmee gebeur het: faseveranderinge met wie en hoekom, notas, antwoorde in albei rigtings, lêers, en elke outomatiseringstap met sy resultaat. Onder skryf jy óf 'n interne nota óf 'n WhatsApp-antwoord. Jy kan enige aansig as CSV, Excel of JSON uitvoer, en een indiening as PDF.

Jou span. Nooi mense per e-pos net na die inkassie uit. Hulle kry 'n liggewig-app van hul eie by /desk en sien nooit die res van jou rekening nie. 'n Rol is 'n beginstel van vermoëns, en elke vermoë kan vir een persoon aan of af gesit word.

RolBegin met
Owner, AdminAlles, insluitend vorms, outomatiserings, verbindings en die span
ManagerNotas, antwoorde, antwoorde wysig, die fase verander, toewys, lêers, uitvoer, verwyder, handmatige aksies uitvoer
AgentNotas, antwoorde, antwoorde wysig, die fase verander, lêers, handmatige aksies uitvoer. Kan 'n indiening vir homself neem
ViewerKan lees, niks anders nie

Jy kan ook beperk wat 'n persoon sien: net sommige vorms, net wat aan hulle toegewys is (met of sonder nie-toegewysde om op te tel), en kontakbesonderhede versteek. Elke aksie van 'n spanlid word in die indiening se geskiedenis geskryf.

Die persoon se eie bladsy. Elke indiening het 'n privaat bladsy by /s/a-long-code, sonder aanmelding: die fase, die boodskappe en faseveranderinge tot dusver, jou oop vraag met sy knoppies, en "Add information" wanneer die vorm dit toelaat. Interne notas en interne velde is nooit daarop nie.

Privaatheid. As 'n kontak uitgevee word, word hul indienings en lêers uitgevee. 'n Vorm kan 'n bewaartyd hê, waarna gesloten indienings uitgevee word.

Outomatiserings

'n Outomatisering lees soos 'n sin: wanneer iets gebeur, as sekere dinge waar is, doen hierdie dinge in volgorde. "Wanneer 'n Quote request ingedien word, as die hoeveelheid 20 of meer is, wys dit aan Managers toe en e-pos die eienaar."

WanneerDit loop wanneer
submitted'n indiening is volledig en sy lêers het aangekom
status_changeddie fase verander het (opsioneel: na of van sekere fases)
assigneddie persoon wat dit toegewys is, het verander
updatedantwoorde of interne velde is gewysig
note_added'n spanlid het 'n nota geskryf
file_added'n lêer is later bygevoeg
customer_replieddie persoon wat dit gestuur het, het teks of lêers bygevoeg
buttondie persoon het 'n knoppie van een van jou antwoorde getik
overduedit is nog in dieselfde fase na 'n aantal minute
duedie sperdatum het verbygegaan terwyl dit oop was
manual'n spanlid druk die aksie se knoppie op die indiening

As: reëls oor antwoorde, berekende waardes, die fase, die kanaal, etikette en die persoon wat toegewys is. 'n Reël is 'n veld, 'n operator en 'n waarde: equals, not_equals, in, not_in, contains, empty, not_empty, gt, gte, lt, lte. Voeg reëls saam met all (en) of any (of).

DoenWat dit doen
set_statusskuif dit na 'n fase, met 'n nota
assignaan 'n lid, om die beurt oor 'n rol, aan die minste besige lid van 'n rol, of aan niemand nie
set_field, calculateskryf 'n interne veld, of werk een uit met 'n formule
tag, set_priority, set_dueetikette, prioriteit, 'n sperdatum
reply'n WhatsApp-boodskap aan die persoon, met tot 3 knoppies wat elk die fase skuif, 'n lêer, of die skakel na hul statusbladsy
ask_locationvra die persoon om te deel waar hulle is
send_formstuur 'n opvolgvorm; wat terugkom, word aan hierdie indiening geheg
emailaan die eienaar, die toegewysde persoon, die persoon, of enige adres, met die lêers aangeheg
notify'n e-pos aan die toegewysde persoon, 'n rol, of almal in die span
http, openapi, mcproep 'n verbinding en hou dele van die antwoord in velde
waitgaan later voort, net as die voorwaardes nog geld
stopeindig hier

Elke lopie word stap vir stap gelog: wat gestuur is, wat teruggekom het, hoe lank dit geneem het. "Try with a submission" loop 'n outomatisering teen 'n werklike indiening sonder om iets te verander of te stuur. 'n Roeping na 'n uitstelsel wat misluk, word weer probeer na 1 minuut, 10 minute en 1 uur; daarna word die outomatisering as misluk gemerk en jou webhooks kry submit.automation_failed. Outomatiserings wat mekaar aan die gang sit, word na drie vlakke gestop.

Resep 1: groot kwotasies gaan na 'n bestuurder

{
  "name": "Large quotes go to a manager",
  "form": "quote_request",
  "enabled": true,
  "trigger": "submitted",
  "options": {},
  "conditions": {
    "all": [
      {
        "field": "quantity",
        "gte": 20
      }
    ]
  },
  "actions": [
    {
      "type": "assign",
      "to": "role:manager"
    },
    {
      "type": "set_priority",
      "priority": "high"
    },
    {
      "type": "email",
      "to": [
        "owner"
      ],
      "subject": "Large quote {reference}",
      "body": "{contact.name} asked for a quote.\n\n{answers}\n\n{desk_link}",
      "attach_files": true
    }
  ]
}

Resep 2: stuur die kwotasie, vra vir 'n antwoord, herinner na drie dae

quote_amount is 'n interne veld wat jou span invul voordat die indiening na Quoted geskuif word. Die herinnering gaan net uit as die indiening nog in Quoted is.

{
  "name": "Send the quote and ask for an answer",
  "form": "quote_request",
  "enabled": true,
  "trigger": "status_changed",
  "options": {
    "to": [
      "quoted"
    ],
    "from": []
  },
  "conditions": {
    "field": "status",
    "equals": "quoted"
  },
  "actions": [
    {
      "type": "reply",
      "text": "Your quote {reference}: {quote_amount}. Would you like to go ahead?",
      "link": true,
      "buttons": [
        {
          "id": "accept",
          "title": "Accept",
          "set_status": "accepted"
        },
        {
          "id": "decline",
          "title": "Decline",
          "set_status": "declined"
        }
      ]
    },
    {
      "type": "wait",
      "minutes": 4320
    },
    {
      "type": "reply",
      "text": "A reminder about your quote {reference}. Tap Accept or Decline, or write to us with any question."
    }
  ]
}

Resep 3: sit 'n meterlesing wat verkeerd lyk, opsy

usage is 'n berekende waarde: reading - previous('reading').

{
  "name": "Query a reading that looks wrong",
  "form": "meter_reading",
  "enabled": true,
  "trigger": "submitted",
  "options": {},
  "conditions": {
    "any": [
      {
        "field": "usage",
        "lt": 0
      },
      {
        "field": "usage",
        "gt": 2000
      }
    ]
  },
  "actions": [
    {
      "type": "set_status",
      "status": "queried",
      "note": "Usage {usage} kWh is outside the usual range."
    },
    {
      "type": "notify",
      "to": "role:manager",
      "text": "Reading {reference} for meter {meter_no} needs a check: usage {usage} kWh."
    }
  ]
}

Verbindings

'n Verbinding is 'n uitstelsel wat 'n outomatisering kan roep. Jou rekening se webhooks het geen nodig nie: hulle ontvang elke indieningsgebeurtenis soos dit gebeur (sien die gebeurtenisse). Vir alles anders is daar drie soorte. "Test" op 'n verbinding, en "Try with a submission" op 'n aksie, wys die werklike versoek en die werklike antwoord voordat enigiets aangeskakel word.

HTTP-versoek

'n Basisadres en 'n manier om aan te meld (geen, 'n draer-token, 'n kopstuk, gebruikersnaam en wagwoord, of 'n sleutel in die adres). Die aksie noem die metode, die pad, en 'n JSON-liggaam. save hou dele van die antwoord in velde van die indiening.

{
  "key": "billing",
  "name": "Billing",
  "kind": "http",
  "base_url": "https://billing.example.com/api",
  "auth": {
    "type": "bearer",
    "secret": "YOUR_BILLING_TOKEN"
  },
  "enabled": true
}
{
  "type": "http",
  "connection": "billing",
  "method": "POST",
  "path": "/readings",
  "body": {
    "meter": "{meter_no}",
    "reading": "{reading}",
    "usage": "{usage}",
    "reference": "{reference}",
    "photo": "{files.photo}"
  },
  "save": {
    "billing_id": "$.id"
  },
  "on_fail": "retry"
}

OpenAPI-dokument

Gee die adres van 'n OpenAPI 3-dokument in JSON, of plak dit. app2email lees sy bewerkings; die aksie kies een volgens sy id en vul sy parameters in. YAML- en Swagger 2-dokumente word nie gelees nie.

{
  "key": "helpdesk",
  "name": "Helpdesk",
  "kind": "openapi",
  "base_url": "https://helpdesk.example.com/api",
  "spec_url": "https://helpdesk.example.com/openapi.json",
  "auth": {
    "type": "header",
    "name": "X-Api-Token",
    "secret": "YOUR_HELPDESK_TOKEN"
  },
  "enabled": true
}
{
  "type": "openapi",
  "connection": "helpdesk",
  "operation": "createTicket",
  "params": {
    "title": "Problem {reference}: {category}",
    "description": "{description}",
    "reporter": "{contact.phone}"
  },
  "save": {
    "ticket_id": "$.id"
  },
  "on_fail": "retry"
}

MCP-bediener

Gee die adres van 'n MCP-bediener (streambare HTTP) en sy token. app2email lys die bediener se gereedskap; die aksie kies een en vul sy argumente in. $text hou die hele antwoord van die gereedskap as teks.

{
  "key": "dispatch",
  "name": "Dispatch",
  "kind": "mcp",
  "base_url": "https://dispatch.example.com/mcp",
  "auth": {
    "type": "bearer",
    "secret": "YOUR_DISPATCH_TOKEN"
  },
  "enabled": true
}
{
  "type": "mcp",
  "connection": "dispatch",
  "tool": "close_job",
  "arguments": {
    "job_id": "{job}",
    "summary": "{work_done}",
    "minutes": "{time_spent}",
    "photos": "{files.photos}"
  },
  "save": {
    "dispatch_answer": "$text"
  },
  "on_fail": "continue"
}

Goed om te weet. 'n Waarde wat presies een plekhouer is, hou sy tipe ('n getal bly 'n getal, 'n lys bly 'n lys). Geheime word geënkripteer gestoor, nooit weer gewys nie en nooit deur die API teruggegee nie. Adresse moet https en openbaar wees: private, plaaslike en interne adresse word geweier, en herleidings word nie gevolg nie. 'n Roeping mag 15 sekondes neem en sy antwoord mag 256 KB wees. In save is 'n pad $ (die hele antwoord) of 'n gewone pad soos $.data.items[0].id.

Plekhouers

Elke teks en elke parameter van 'n aksie kan plekhouers in krullerige hakies gebruik. 'n Naam wat nie bekend is nie, bly soos jy dit getik het.

PlekhouerWord
{<field key>}die antwoord op daardie vraag (ook interne velde, berekende waardes en waardes wat 'n outomatisering gestoor het)
{reference}die verwysing, bv. MR-7Q3M2A
{form} {form_key}die vorm se naam en sy sleutel
{status} {status_name}die fase se sleutel en sy naam
{channel}whatsapp, web, api of staff
{priority} {tags}die prioriteit en die etikette
{created} {updated} {due}die tye
{contact.name} {contact.phone} {contact.email}die persoon wat dit gestuur het
{assignee.name} {assignee.email}die spanlid wat dit toegewys is
{link}die persoon se eie statusbladsy
{desk_link}die indiening in jou span se inkassie
{answers}alle antwoorde as "Etiket: waarde"-reëls
{files} {files.<field key>}skakels na alle lêers, of na die lêers van een vraag; 'n ander stelsel kan hulle 7 dae haal
{note}die nota van die faseverandering, of die nota wat die outomatisering aan die gang gesit het
{button}die knoppie wat die persoon gedruk het
{business}jou besigheidsnaam
{submission}in 'n JSON-liggaam: die hele indiening as 'n voorwerp
{= formula }'n formule wat op die plek uitgewerk word, bv. {= round(qty * 1.1, 2) }

Formules

Gebruik deur berekende waardes, deur die calculate-aksie, en binne {= ... } in enige teks. 'n Formule werk met getalle, tekste tussen enkele aanhalingstekens en die sleutels van jou vrae. Dit kan 500 karakters lank wees. Deel deur nul, of 'n getal wat ontbreek, gee 'n leë waarde in plaas van 'n fout.

Jy skryfBeteken
+ - * / %rekenkunde op getalle en antwoorde
== != > >= < <=vergelykings
and or not ( )logika en hakies
if(condition, a, b)a wanneer die voorwaarde geld, anders b
min(a, b, ...) max(a, b, ...)die kleinste, die grootste
round(x, n) abs(x)afronding tot n desimale, die grootte van 'n getal sonder sy teken
num(x) len(x)'n teks as 'n getal; die lengte van 'n teks of 'n lys
coalesce(a, b)a, of b wanneer a leeg is
lower(x) upper(x) concat(a, b, ...)tekste
lookup('list', id, 'column')'n kolom van 'n ry van een van jou lyste, bv. 'n prys
previous('field')dieselfde persoon se vorige antwoord op daardie vraag
count_files('field')hoeveel lêers 'n vraag hou
days_since(date)dae van 'n datum tot vandag

Voorbeelde: qty * lookup('prices', product, 'price') vir 'n onmiddellike beraming; reading - previous('reading') vir verbruik; if(amount > 500, 'manager', 'agent') om te besluit wie goedkeur.

Vir ontwikkelaars en KI-agente

Alles hierbo is in die REST API onder /v1/{number}/submit, waar {number} jou WhatsApp-nommer is met die landkode, slegs syfers. Stuur jou API-sleutel as Authorization: Bearer YOUR_API_KEY (die X-API-KEY-kopstuk word ook aanvaar). Die sleutel benodig die scope submissions:manage; sleutels met volle toegang het dit, die Default-sleutel nie. Sandbox-sleutels kan nie skryf nie.

  1. GET /submit/guide: een JSON-dokument met die hele woordeskat: vraagtipes met hul keuses en limiete, fasereëls, snellers, operators, aksies met hul parameters, plekhouers, formulefunksies, die sjablone, en werkende voorbeelde.
  2. POST /submit/setup met "dry_run": true: niks word geskryf nie; elke probleem kom terug met sy pad en 'n sin wat sê hoe om dit reg te maak.
  3. POST /submit/setup sonder dry_run: lyste, verbindings, vorms en outomatiserings word saam toegepas. Met enige probleem word niks geskryf nie.
  4. POST /submit/forms/{key}/publish, of noem die vorms in "publish" van die opstellingsdokument.
  5. Deel die vorm se skakels (GET /submit/forms/{key} gee hulle), lees dan GET /submit/submissions of luister na die webhook-gebeurtenisse.

'n Volledige opstellingsroeping

Stoor die dokument hieronder as setup.json en stuur dit. Vervang 61400000000 met jou nommer. Dit kontroleer 'n meterlesing-oplossing: 'n lys terreine, 'n verbinding na 'n faktureringstelsel, een vorm met drie fases en 'n berekende verbruik, en twee outomatiserings. Verwyder "dry_run": true om dit toe te pas. Bestaande vorms, lyste en verbindings met dieselfde sleutel word vervang; outomatiserings word volgens naam binne die vorm gepas. "preset": "..." in plaas van die dele installeer een van die sjablone (GET /submit/presets lys hulle).

curl -X POST "https://api.app2email.com/v1/61400000000/submit/setup" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d @setup.json
{
  "dry_run": true,
  "settings": {
    "enabled": true,
    "config": {
      "business_name": "Northside Energy",
      "default_prefix": "NE"
    }
  },
  "lists": [
    {
      "key": "sites",
      "name": "Sites",
      "items": [
        {
          "id": "north",
          "title": "North depot"
        },
        {
          "id": "south",
          "title": "South depot"
        }
      ]
    }
  ],
  "connections": [
    {
      "key": "billing",
      "name": "Billing",
      "kind": "http",
      "base_url": "https://billing.example.com/api",
      "auth": {
        "type": "bearer",
        "secret": "YOUR_BILLING_TOKEN"
      },
      "enabled": true
    }
  ],
  "forms": [
    {
      "key": "meter_reading",
      "name": "Meter reading",
      "definition": {
        "title": "Meter reading",
        "description": "Send us your reading. It takes about a minute.",
        "prefix": "MR",
        "steps": [
          {
            "key": "reading",
            "title": "Your reading",
            "text": "",
            "show_if": null,
            "fields": [
              {
                "key": "site",
                "type": "select",
                "label": "Site",
                "required": true,
                "list": "sites"
              },
              {
                "key": "meter_no",
                "type": "text",
                "label": "Meter number",
                "help": "Printed on the front of the meter",
                "required": true,
                "max_length": 30
              },
              {
                "key": "reading",
                "type": "number",
                "label": "Reading",
                "required": true,
                "min": 0,
                "decimals": 0,
                "unit": "kWh"
              },
              {
                "key": "photo",
                "type": "photo",
                "label": "Photo of the meter",
                "required": false,
                "max_files": 1,
                "source": "any"
              },
              {
                "key": "billing_id",
                "type": "text",
                "label": "Billing record",
                "internal": true
              }
            ]
          }
        ],
        "stages": [
          {
            "key": "received",
            "name": "Received",
            "kind": "open",
            "color": "blue",
            "set_by": [],
            "require_note": false,
            "message": ""
          },
          {
            "key": "queried",
            "name": "Queried",
            "kind": "open",
            "color": "amber",
            "set_by": [],
            "require_note": true,
            "message": "We have a question about your reading {reference}. We will be in touch."
          },
          {
            "key": "checked",
            "name": "Checked",
            "kind": "done",
            "color": "green",
            "set_by": [],
            "require_note": false,
            "message": ""
          }
        ],
        "who": {
          "mode": "anyone",
          "numbers": [],
          "tag": ""
        },
        "trigger": {
          "words": [
            "meter",
            "reading"
          ],
          "header": "",
          "body": "Tap the button to send your reading.",
          "button": "Open form",
          "footer": ""
        },
        "after": {
          "review_step": true,
          "reply": "Thanks {contact.name}. We have your reading - reference {reference}.",
          "allow_additions": false,
          "status_page": true
        },
        "web": {
          "enabled": true,
          "verify": "optional",
          "ask_email": false,
          "success_text": "Thank you. We have your reading."
        },
        "notify": {
          "email": true,
          "to": [],
          "attach_files": true
        },
        "calculated": [
          {
            "key": "usage",
            "label": "Usage",
            "formula": "reading - previous('reading')",
            "unit": "kWh",
            "decimals": 0
          }
        ],
        "retention_days": 0
      }
    }
  ],
  "automations": [
    {
      "name": "Query a reading that looks wrong",
      "form": "meter_reading",
      "enabled": true,
      "trigger": "submitted",
      "options": {},
      "conditions": {
        "any": [
          {
            "field": "usage",
            "lt": 0
          },
          {
            "field": "usage",
            "gt": 2000
          }
        ]
      },
      "actions": [
        {
          "type": "set_status",
          "status": "queried",
          "note": "Usage {usage} kWh is outside the usual range."
        },
        {
          "type": "notify",
          "to": "role:manager",
          "text": "Reading {reference} for meter {meter_no} needs a check: usage {usage} kWh."
        }
      ]
    },
    {
      "name": "Send good readings to billing",
      "form": "meter_reading",
      "enabled": true,
      "trigger": "submitted",
      "options": {},
      "conditions": {
        "all": [
          {
            "field": "usage",
            "gte": 0
          },
          {
            "field": "usage",
            "lte": 2000
          }
        ]
      },
      "actions": [
        {
          "type": "http",
          "connection": "billing",
          "method": "POST",
          "path": "/readings",
          "body": {
            "meter": "{meter_no}",
            "reading": "{reading}",
            "usage": "{usage}",
            "reference": "{reference}",
            "photo": "{files.photo}"
          },
          "save": {
            "billing_id": "$.id"
          },
          "on_fail": "retry"
        },
        {
          "type": "set_status",
          "status": "checked",
          "note": "Sent to billing as {billing_id}."
        }
      ]
    }
  ],
  "publish": [
    "meter_reading"
  ]
}

Die antwoord van die werklike roeping (sonder dry_run):

{
  "success": true,
  "request_id": "req_...",
  "applied": {
    "lists": [
      "sites"
    ],
    "connections": [
      "billing"
    ],
    "forms": [
      "meter_reading"
    ],
    "automations": [
      "Query a reading that looks wrong",
      "Send good readings to billing"
    ],
    "published": [
      "meter_reading"
    ]
  },
  "problems": []
}

Die ander roetes

  • Instellings: GET / PUT /submit/settings.
  • Vorms: lys, skep (uit 'n definisie of 'n sjabloon), lees, werk by, skrap, publiseer, en POST /submit/forms/{key}/send om 'n vorm na 'n nommer te stuur met waardes ingevul.
  • Lyste: PUT /submit/lists/{key} vervang die rye van 'n lys.
  • Indienings: lys (filter volgens vorm, fase, toegewysde persoon, etiket, kanaal, kontak, teks en datums; updated_after vir sinkronisering; CSV met ?format=csv), skep, lees volgens id of verwysing, werk by (fase, nota, prioriteit, toegewysde persoon, sperdatum, etikette, antwoorde, interne velde), voeg 'n nota by, antwoord met knoppies, voeg 'n lêer by, skrap.
  • Outomatiserings en lopies: lys, skep, lees, werk by, skrap, POST /submit/automations/try, en die lopielog.
  • Verbindings: lys, stel, skrap, toets, verfris, en die funksies wat 'n aksie kan roep.
  • Span en verslag: nooi uit, werk by en verwyder lede; tellings volgens vorm, fase, dag en toegewysde persoon.

Webhook-gebeurtenisse

Elke webhook van jou rekening kry elke gebeurtenis. Elkeen dra die indiening soos dit op daardie oomblik is; lêerskakels daarin werk 7 dae.

GebeurtenisWanneer
submission.created'n indiening bestaan (sy lêers mag nog aankom)
submission.files_readysy lêers is gestoor
submission.updatedantwoorde, interne waardes, prioriteit, etikette of die sperdatum het verander
submission.status_changeddie fase het verander
submission.assigneddie toegewysde persoon het verander
submission.note_added'n nota is geskryf
submission.customer_replieddie persoon het teks, lêers of 'n opvolging bygevoeg, of 'n knoppie gedruk
submission.deleteduitgevee of uitgewis
submit.automation_failed'n outomatisering het opgegee ná sy herprobeerings

MCP-gereedskap

Elke roete is ook 'n gereedskap op app2email se gehoste MCP-bediener, sodat 'n assistent die hele opstelling in 'n gesprek kan doen: get_submit_guide, apply_submit_setup, list_submit_presets, create_form, publish_form, send_form, list_submissions, get_submission, update_submission, reply_to_submission, create_automation, try_automation, set_connection, test_connection en meer. 'n Goeie eerste boodskap aan die assistent: "Lees die Submit-Info-gids, en stel dan 'n probleemverslagvorm op met foto's en 'n ligging, en vertel my bestuurders van dringende een."

claude mcp add --transport http app2email https://api.app2email.com/mcp --header "Authorization: Bearer YOUR_API_KEY"

Meer oor die koppeling van assistente en outomatiseringsgereedskap: Outomatiseringsgereedskap en agente.

Limiete

LimietWaarde
Vorms per nommer100
Stappe in 'n vorm, vrae in 'n stap12 en 12 (60 vrae in 'n vorm, een liggingsvraag)
Lyste50, elk tot 1,000 rye
Outomatiserings, verbindings, spanlede200, 30, 200
Lêers in een indiening60
Lêergrootte25 MB van WhatsApp, 10 MB van die webblad of die API
'n Nota of 'n antwoord4,000 karakters
Etikette op 'n indiening20
Roepings na uitstelsels60 per minuut en 2,000 per dag per nommer; 15 sekondes en 256 KB per roeping
Lopielog30 dae bewaar

Nog nie beskikbaar nie

  • 'n Betaling op 'n indiening neem ('n kwotasie word aanvaar, nie betaal nie).
  • 'n Vorm stuur na iemand wat die afgelope 24 uur nie aan jou geskryf het nie as 'n WhatsApp-vorm: jy kry hulle persoonlike webskakel in plaas daarvan, om met enige goedgekeurde sjabloon te stuur.
  • Handtekeninge.
  • Herhalende groepe ("voeg nog 'n item by").
  • Halfpad na 'n ander vorm spring.
  • 'n Vorm invul sonder 'n verbinding.
  • Ander tale in die vaste tekste van die webblad (elke teks van jou vorm is joune om te skryf).
  • OpenAPI-dokumente in YAML of Swagger 2, en MCP-bedieners wat net die ouer SSE-vervoer praat.
  • Waardes van foto's af lees.

Alles hierbo word op die dashboard se Submit-Info-bladsy (/dashboard/app/submit) gestel. Vrae: support@app2email.com.