Wapiworld WhatsApp API

GetCheck instanceif statusa WhatsApp number is connected

FetchUse thethis currentwhen safesomeone connectionasks healthwhether fora oneWhatsApp tenant-scopednumber Wapiworldis instanceconnected, withoutwaiting returningfor QR pairing, starting or offline. Returns the instance's name, raw status and a health value: ready, pairing, starting, offline or unknown (no QR codes or authenticationcredentials). data.Not for whether a sent message was delivered.

 ⟨5 unchanged words⟩ ,"properties":{"instanceId":{"description":"Wapiworld instanceInstance id: 24 lowercase hexadecimal characters","pattern" ⟨10 unchanged words⟩ 

 ⟨7 unchanged words⟩ {"type":"boolean"},"health":{"description":"ready: connected; pairing: waiting for a QR scan; starting: connecting; offline: logged out or disconnected; unknown: unrecognized state","enum":["ready","pairing","starting", ⟨45 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCheck instanceif statusa WhatsApp number is connected"}

GetCheck message recording policysettings

InspectUse whetherthis message-contentwhen persistencesomeone isasks enabledwhether byWapiworld defaultstores forthe onetext tenant-scopedof WapiworldWhatsApp instancemessages andfor a number, or how long recordedit rowskeeps arethem. retained.Returns Thiswhether directory-saferecording diagnosticis neveron readsfor messagethe bodiesinstance, previewswhether the default, senderproject namesor instance decided it, contactany identifierslock, chat-leveland overridethe keys,project's orretention WhatsAppin messagedays. ids.Not for reading recorded messages.

 ⟨5 unchanged words⟩ ,"properties":{"instanceId":{"description":"Tenant-scoped Wapiworld instanceInstance id to inspect: 24 lowercase hexadecimal characters","pattern":" ⟨10 unchanged words⟩ 

 ⟨67 unchanged words⟩ :"object"},{"type":"null"}],"description":"Instance default only; chat-level exceptions are excluded. Message bodies, previews, sender names, contact identifiers, chat override keys and WhatsApp message ids are never read."},"status":{"enum":["found", ⟨9 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCheck message recording policysettings"}

List instancesWhatsApp numbers

ListUse athis boundedwhen pagesomeone ofasks tenant-scopedwhich WhatsApp numbers they have connected to Wapiworld, WhatsAppor instanceswhich ones are offline. Returns each instance's id, optionallyname, filteredWhatsApp byaccount project.name, Resultsphone includenumber, operationalconnection status and phonehealth, metadata25 butper neverpage QRby pairingdefault, optionally for one project (no QR codes, instance secrets, or API keys, proxy). data,Not orfor arbitrarysending storeda fields.message.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe paginationpage.nextCursor cursorof returnedthe byprevious apage previouswith callthe same projectId; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"MaximumInstances instancesper topage, returnfrom (default1 25,to

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"instances":{"description":"Connected WhatsApp instances. health is ready, pairing, starting, offline or unknown. QR pairing codes, instance secrets, API keys, proxy data and arbitrary stored fields are never returned.","items":{"additionalProperties":false,"properties":{" ⟨92 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"Pass nextCursor as cursor, with the same filters, for the next page; null on the last page","properties":{"count":{"minimum":0 ⟨24 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List instancesWhatsApp numbers"}

List your Wapiworld projects

ListUse athis boundedwhen pagesomeone ofasks which Wapiworld projects available tothey thehave, authenticatedor organization.a API-keyproject's sessionsid remainis pinnedneeded. toReturns theireach singleproject's project.id, Internalname organizationand idscreation and projectedit configurationtimes, are25 omitted.per page by default, with a cursor for more. Not for their WhatsApp numbers.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe paginationpage.nextCursor cursorof returnedthe byprevious apage; previousabsent callfor the first page","maxLength":4096,"type":"string"},"limit":{"description":"MaximumProjects projectsper topage, returnfrom (default1 25,to

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"Pass nextCursor as cursor, with the same filters, for the next page; null on the last page","properties":{"count":{"minimum":0," ⟨23 unchanged words⟩ ],"type":"object"},"projects":{"description":"Projects the session can reach; an API-key session sees only its own project. Internal organization ids and project configuration are omitted.","items":{"additionalProperties":false,"properties":{ ⟨43 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List your Wapiworld projects"}

ListCheck webhook subscriptionsdelivery health

List a bounded page of theUse organization’sthis Wapiworldwhen webhooksomeone subscriptionsasks withwhether their subscribed eventsWapiworld andwebhooks deliveryare healthworking, sofailing aor stoppedwere webhookswitched canoff. beReturns diagnosed.each Ansubscription's endpoint that fails 20scheme deliveriesand inhost, aevents, rowactive isstate, disabledconsecutive automatically.failures Requiresand an operator OAuth session; API-key sessions cannotauto-disabled readflag thisafter route.20 Thefailures, signing25 secretper ispage neverby returned,default. andWorks only the scheme and hostwith ofan theoperator deliveryOAuth URLsession, arenot shownan becauseAPI hookkey. pathsNot oftenfor embedchanging a credential.webhook.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe paginationpage.nextCursor cursorof returnedthe byprevious apage previouswith callthe same projectId; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Maximum webhookWebhook subscriptions toper returnpage, (defaultfrom 25,1 maximumto

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"Pass nextCursor as cursor, with the same filters, for the next page; null on the last page","properties":{"count":{"minimum":0," ⟨17 unchanged words⟩ ],"type":"object"},"webhookSubscriptions":{"description":"Delivery health per subscription; autoDisabled marks an endpoint switched off after 20 consecutive failures. The signing secret, delivery paths, queries and fragments are never returned: hook paths often embed a credential.","items":{"additionalProperties":false,"properties":{ ⟨80 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"ListCheck webhook subscriptionsdelivery health"}

Send oneUse realthis externalwhen WhatsAppsomeone textasks messageto throughsend a tenant-scoped Wapiworld instance. ThisWhatsApp destructive,message open-worldfrom actionone isof non-idempotent:their showWapiworld thenumbers. exactReturns senderonly instance,that recipientWapiworld andaccepted completethe textsend, obtain explicit confirmation fornot oneproof send,of calldelivery. once,The andmessage nevergoes retryout automaticallyimmediately, wheneach thecall outcomesends isanother uncertain.copy, Doand notrecording includesettings restrictedmay data.store Existingits Wapiworldtext. recordingNot settingsfor maybroadcasts persistor outboundbulk content.sends.

 ⟨72 unchanged words⟩ :"string"},"instanceId":{"description":"The tenant-scoped WapiworldSender instance id, shown to sendthe fromuser before confirmation","maxLength":128,"minLength":1,"type ⟨7 unchanged words⟩ 

 ⟨6 unchanged words⟩ :{"status":{"const":"accepted","description":"Wapiworld accepted the send for transport; not proof of delivery or reading","type":"string"}},"required":["status ⟨2 unchanged words⟩ 

RenderUse athis boundedwhen operationalsomeone wants a quick overview foror onedashboard tenant-scopedof Wapiworldone project,Wapiworld includingproject's WhatsApp instancenumbers. healthReturns andan safeoverview phonecard metadata.with QRthe pairingproject codesname, instancehow credentialsmany instances are ready, APIpairing, keysstarting, proxyoffline dataor unknown (counting up to 100), and arbitraryup storedto fields20 areinstances excluded.with phone and status. Not for sending a message.

 ⟨3 unchanged words⟩ ,"properties":{"projectId":{"description":"Wapiworld projectProject id to summarize","maxLength":128,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨14 unchanged words⟩ {"type":"boolean"},"instances":{"description":"Up to 20 instances. QR pairing codes, instance credentials, API keys, proxy data and arbitrary stored fields are excluded.","items":{"additionalProperties":false,"properties":{" ⟨152 unchanged words⟩ 

{"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Show Wapiworld project overview"}