Tekstiviestisi lähetetään omasta puhelimestasi.Katso, miten se toimii
ILMA-AINEISTOAPI-ensimmäinen arkkitehtuuriTurvallisen laitteen paritusToimituksen näkyvyysMonilaiteohjausVersioasiakirjat
Kehittäjän solmupiste/##WhatsApp#API

WA · 9 dokumentoitua toimintoa

WhatsApp API-dokumentaatio

Send WhatsApp messages and media, retry failures, verify recipient numbers and securely retrieve received messages after an explicit synchronization request.

Yhteydet puhelimiin ja puheluihin
REST-tukikohdan URLhttps://api.smsmobileapi.com

JSON-vasteet · HTTPS vaaditaan · UTF-8

Yhdistä API-näppäin

Yhdistä kerran, sitten testata päätetapahtumia SMS, puhelut, ilmoitukset, WhatsApp ja sähköposti.

Aloita tästä.

Ensimmäinen pyyntösi neljässä vaiheessa

1

Yhdistä ja ota WhatsApp käyttöön tuettua mobiilia varten.

2

Vahvista vastaanottajan numerotarkistuspäätetapahtuma.

3

Lähetä vain yksi.

4

To retrieve received messages: activate collection, call /getwa/synchronisation/, wait for recovery, then call /getwa.

MANDATORY BEFORE RETRIEVING RECEIVED MESSAGES

Request WhatsApp synchronization first.

Before calling /getwa to view received WhatsApp messages, you must request a synchronization window through https://api.smsmobileapi.com/getwa/synchronisation/. This explicit step is required to securely authorize the exchange between WhatsApp and SMSMobileAPI. Wait for recovery, then call /getwa.

Open the required synchronization endpoint →
Turvallinen SMSMobileAPI-mobiilisovellus, joka yhdistää puhelimen verkkokojelautaan ja REST API-sovellus SMS- ja puhelutoimintoihin
Salattu mobiili-lautalta-liitäntä

Virallinen mobiilisovellus

Turvallinen silta puhelimen, kojelauta ja API:n välillä.

SMS- ja puhelutoiminnot kulkevat puhelimeen asennetun virallisen SMSMobileAPI-sovelluksen kautta. Sovellus yhdistää laitteen turvallisesti tiliisi, synkronoi hyväksytyt tapahtumat ja linkittää mobiiliverkon kojelautaan ja REST API:iin.

1MobiilisovellusParittele puhelin ja sen SIM 2Salattu linkkiTunnistaa ja suojaa tietoja kauttakulussa 3& APIHallitsee työnkulkua ja toimintaa
  • Allekirjoitetut tiedotteet, jotka on jaettu virallisten Google Play- ja Apple App Store -listausten kautta
  • Google ja Apple -alustan katselmointi, allekirjoittaminen ja jakelun valvonta
  • Turvalaiteparitus, HTTPS-kuljetus ja aito API-yhteys
  • Vain mobiiliominaisuuksille tarvittavat oikeudet
Hanki virallinen SMSMobileAPI-sovellus Google Playsta Download the official SMSMobileAPI app on the Apple App Store
Kyvyt riippuvat Android:n tai iOS:n sallimista käyttöoikeuksista ja tausta-aineistoista.

WEBHOOK V2 TÄLLE API:LLE

Tilaa vain ne mobiilitapahtumat, joita työnkulkusi tarvitsee.

5 tapahtumatyyppiä

Yksi kohde voi vastaanottaa kaiken, tai voit erotella tuotantojärjestelmät, analytiikan ja operatiiviset hälytykset. Jokaisella tapahtumalla on tarkka nimi, jotta sovelluksesi käsittelee ne ennustettavasti.

whatsapp.submitted

WhatsApp lähetetty

Luotiin WhatsApp-lähetystehtävä.

whatsapp.sent

WhatsApp lähetetty

Yhdistetty WhatsApp-ympäristö vahvisti viestin lähetyksen.

whatsapp.failed

WhatsApp epäonnistui

WhatsApp-lähetys epäonnistui.

whatsapp.received

WhatsApp vastaanotettu

Tilin synkronointipyynnön jälkeen haettiin WhatsApp-viesti.

whatsapp.voice.transcribed

Ääniviesti muunnettu tekstiksi.

Kelvollinen haettu WhatsApp-ääniviesti muutettiin käyttökelpoiseksi tekstiksi.

Todennus

Pidä tiedot palvelimellasi

Käytä apikey suora integraatiot. OAuth2 -asiakastunnukset ovat saatavilla palvelinsivusovelluksiin; pyydä token ja lähetä se valtuutuksena: Bearer ACLE TOKEN.

Historianhallinta

Tyhjennä historia turvallisesti: esikatselu, poista, seuraa edistymistä

Nämä päätepisteet tyhjentävät valitun palvelimen historian API-avaimellesi, eivät puhelimissa tai ulkoisissa palveluissa. Niissä ei säädetä tilien poistamisesta. Uusia toimintoja voi ilmaantua poistamisen jälkeen.

Lue request_id ja yritä uudelleen opas
Kotouttamisen suoja

Oletuksena on, että linkit tai käsittely kirjataan edelleen näkyviin. Käytä include_linked=1:ää vain, jos hyväksyt, että integraatiot tai jatkuva käsittely voivat lopettaa työskentelyn.

Miten request_id vaikuttaa

  1. Esikatsele lukuja action=preview: llä. request_id:ää ei tarvita eikä tietueita poisteta.
  2. Luo ainutlaatuinen request_id uuden poiston, esimerkiksi UUID. Tallenna se ennen action=delete:n lähettämistä.
  3. ennallistamis-, aikakatkaisu- tai HTTP 202, uudelleenkäyttäydy samalla tavalla API avain, historian päätetapahtuma, request_id sekä include_linked arvo. Älä koskaan luo uutta tunnistetta automaattisesti virheen jälkeen.
  4. Kun completed=true, operaatio on päättynyt. Henkilötunnuksen uudelleenkäyttö palauttaa saman tuloksen sen sijaan, että poistaisi uudet tietueet. Käytä uutta henkilökorttia vain tarkoituksella uuteen siivoukseen.

request_id tunnistaa poistotoimintosi, ei yksittäinen SMS. Sallittu muoto: 16...128 ASCII kirjaimet, numerot, väliviivat tai alleviivat. UUID:n generoitu salauksella.randomUID() sopii hyvin.

Poisto etenee erissä. Jos vastaus on HTTP 202 ja continue_required=true, toista action=delete 3 sekunnin kuluttua. Taustalla ei suoriteta cron-tehtävää. action=status vain lukee edistymisen eikä jatka poistoa, vaikka vastaus olisi HTTP 200.

Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET also accepts action=preview or action=delete. POST is recommended: URL parameters can leak into browser history and server logs. Never place a deletion URL in a public link, image or prefetch.

Lähetä POST:lle kaikki parametrit muodossa keho tai JSON:n objekti, älä koskaan kyselyn merkkijonossa. Tuntematon parametreja hylätään; päivämäärä tai liikkuvia suodattimia ei tueta.

Historiallisten päätetapahtumien todentaminen

Käyttö apikey tai Authorization: Bearer kulkutunnus, jonka on antanut SMSMobileAPI OAuth2. Älä lähetä virkistävää kuponkia tai API avain Bearer -Ei. Vanhentuneet kuponkit hylätään.

Kun ulottuvuudet on asetettu, history:read mahdollistaa esikatselun/statuksen ja history:delete myös poiston. Sekä token että OAuth-asiakkaan rajoituksia sovelletaan. Perintö rahakkeita ilman soveltamisalaa säilyttää niiden nykyinen tili pääsy.

OAuth2 valitsee ainutlaatuisen ensisijaisen API-avain. Jos on olemassa useita ensisijaisia avaimia, anna apikey myös valita yksi tilin. Toissijaiset avaimet eivät koskaan anna pääsyä ensisijaisen avainhistorian.

Lue vastaus ennen kuin jatkat

count_delete on tämän operaation poistama kumulatiivinen numero. selected_at_start on ensimmäinen valinta; protected_at_start laskee pois tietueita. Käytä preview.linked_or_processing:ää laskeaksesi linkitettyjä tietueita myös include_linked=1:n aikana.

JSON · HTTP 202
{
    "result": {
        "error": 0,
        "history": "whatsapp-sent",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}
  • 200 completed=true: valmis. 200 esikatselu tai tilavaste ei yksin todista valmistumista.
  • 400 INVALID_REQUEST_ID: tarkista muoto. 404 REQUEST_NOT_FOUND: tälle ID:lle, API-avaimelle ja historialle ei ole olemassa operaatiota.
  • 401: pätemättömät tai vanhentuneet tunnukset. 403: riittämätön OAuth-alue tai luvaton tili.
  • 409 HISTORY_BUSY: toinen puhdistus on käynnissä; jatka sitä alkuperäisestä asiakkaasta. 409 INCLUDE_LINKED_CONFLICT: Palauta alkuperäinen include_linked-arvo.
  • 409 OAUTH_ACCOUNT_AMBIGUOUS: anna tälle tilille kuuluva API-avain.
  • 503 tai verkon keskeytys: jotkut erät voidaan jo täyttää. Tarkista asetukset ja yritä sitten uudelleen alkuperäisen request_id:n kanssa. Älä luo korvaavaa toimintoa automaattisesti.
POST · GET

Lähetä WhatsApp-viesti

#
endpointhttps://api.smsmobileapi.com/sendsms

Lähettää WhatsApp-tekstin tai tuetun median yhteyden kautta.

Milloin sitä käytetään

Käytä sitä yksittäisten vastaanottajien tai kojelauta yhteysryhmän.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-näppäintäsi; jätä huomiotta, kun käytät Bearer-tunnusta.
recipients puhelin Pakollinen Maakoodi plus numero ilman + tai 00:aa.
message jono Pakollinen Tekstin runko; useita rivejä tuetaan.
waonly kyllä Pakollinen Täytyy olla kyllä pyytää WhatsApp- vain toimitus.
url_media HTTPS- URL Vapaaehtoinen Julkinen PDF, asiakirja, arkisto tai JPG / PNG URL.
url_media_shorted kyllä Vapaaehtoinen Käytä lyhennettyä lataa URL PDF esikatselu tilassa.
pdf_with_image kyllä Vapaaehtoinen Lisää PDF-levyn kuvaesikatselu.
encrypt_message kyllä Vapaaehtoinen Vaadi vastaanottajan puolen salauksen purku.
contactGroup GUID Vapaaehtoinen Lähetä kaikki kontaktit kojelautaryhmään.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/sendsms?waonly=yes" \
  -d "apikey=YOUR_API_KEY" \
  -d "recipients=191728660" \
  --data-urlencode "message=Your order is ready."

Esimerkkivastaus

JSON
{
  "result": {
    "error": 0,
    "sent": "1",
    "id": "MESSAGE_GUID",
    "send_with_whatsapp": "1"
  }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Tuettujen median URL-osoitteiden on oltava julkisia HTTPS-resursseja.
  • WhatsApp-muotoilu: * lihavoi*, italic , ~strikethrough~ ja triple-backtick monospace.
POST · GET

Resend an unsent WhatsApp message

#
endpointhttps://api.smsmobileapi.com/resendwa/

Palauttaa WhatsApp-viestin, joka on tällä hetkellä virhetila.

Milloin sitä käytetään

Käytä sitä viallisen WhatsApp-lokimerkinnän diagnosoinnin jälkeen.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
guid jono Pakollinen Viestin guid.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/resendwa/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Vain epäonnistuneet viestit ovat oikeutettuja uudelleenlähetykseen.
SAADA

Aktivoi saapuvat hakut

#
endpointhttps://api.smsmobileapi.com/getwa/active/

Aktivoi, sammuttaa tai vaihtaa WhatsApp-viestin hakua.

Milloin sitä käytetään

Activate collection first. Then, before retrieving received messages, you must request synchronization through /getwa/synchronisation/.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
statut 0 ... 1 x Vapaaehtoinen 1 aktivoi, 0 sammuttaa, x tai poisjättäminen valitsee nykyisen tilan.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getwa/active/?apikey=YOUR_API_KEY&statut=1"

Esimerkkivastaus

JSON
{
  "success": true,
  "read_message_active": 1,
  "status_note": "Activated"
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Saapuvan haku on oletusarvoisesti pois käytöstä yksityisyyden vuoksi.
  • Activation alone does not retrieve messages: a synchronization request remains mandatory before using /getwa for newly received activity.
SAADA

Required: request WhatsApp synchronization

#
endpointhttps://api.smsmobileapi.com/getwa/synchronisation/

Mandatory security step before retrieving received WhatsApp messages. It opens a time-limited synchronization window.

Milloin sitä käytetään

You must call this endpoint before /getwa whenever you need SMSMobileAPI to check WhatsApp for newly received messages. Wait for recovery, then call /getwa.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getwa/synchronisation/?apikey=YOUR_API_KEY"

Esimerkkivastaus

JSON
{
  "error": "0",
  "messages": "synchronized",
  "expire_at": "2026-03-11 12:27:00",
  "expire_at_unix": "1773232020"
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Synkronointi on vain viestien vastaanottamiseen. Älä soita ennen kuin lähetät.
  • The response returns expire_at and expire_at_unix. Request another synchronization window when you need to collect newer received messages.
  • A synchronization request is mandatory to protect the exchange between WhatsApp and SMSMobileAPI.
SAADA

Nouda WhatsApp-viestit

#
endpointhttps://api.smsmobileapi.com/getwa

Returns received WhatsApp messages that were recovered during a requested synchronization window.

Milloin sitä käytetään

Mandatory prerequisite: activate inbound retrieval, call https://api.smsmobileapi.com/getwa/synchronisation/ first, wait for recovery, then call this endpoint. /getwa does not itself start synchronization.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
before Unix aikaleima Vapaaehtoinen Palautustiedot ennen tätä aikaleimaa.
date VVVV-KK-PP Vapaaehtoinen Palauta tiedot yhden päivän.
message_type teksti ... ääni Vapaaehtoinen Suodata teksti- tai ääniviestejä, jotka on muunnettu tekstiksi; jätä pois molemmista.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/getwa/?apikey=YOUR_API_KEY&message_type=text"

Esimerkkivastaus

JSON
{
  "date": "2026-03-11",
  "hour": "12:27:00",
  "timestamp": "1773232020",
  "number": "19176728660",
  "contact": "SMSMobileAPI",
  "message": "When will I receive my order?",
  "guid": "652fcfc0-12a8-46f5-b5ba-9391135b8b4c"
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
SAADA

Tarkista WhatsApp-numero

#
endpointhttps://api.smsmobileapi.com/whatsapp/checknumber/

Tarkistaa, onko puhelinnumero saatavilla WhatsApp.

Milloin sitä käytetään

Käytä sitä ennen lähettämistä vähentää vältettävissä epäonnistumisia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Pakollinen API-avaimesi.
recipients puhelin Pakollinen Maakoodi plus numero ilman + tai 00:aa.

Esimerkki pyynnön esittämisestä

cURL
curl "https://api.smsmobileapi.com/whatsapp/checknumber/?apikey=YOUR_API_KEY&recipients=19176728660"

Esimerkkivastaus

JSON
{
  "contact_found_on_whatsapp": "yes",
  "recipients": "19176728660"
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
LÄHETTÄÄ

Luo OAuth2 -käyttötunnus

#
endpointhttps://api.smsmobileapi.com/oauth2/token

Vaihdaa asiakkaan tiedot Bearer-tunnus.

Milloin sitä käytetään

Käytä sitä palvelin-palvelin-integraatioissa, joissa lyhytikäiset tiedot ovat suositeltavia.

Parametrit

NimiTyyppiVaatimusKuvaus
grant_type jono Pakollinen - Varmaan asiakasedustaja.
client_id jono Pakollinen Asiakkaan henkilöllisyystodistus kojelaudalta.
client_secret jono Pakollinen Asiakassalaisuus kojelaudalta.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Pidä asiakas salassa palvelimellasi. Älä koskaan sisällytä sitä mobiili- tai selainkoodiin.
POST · GET

Tyhjennä lähetettyjen WhatsApp-viestien historia

#
endpointhttps://api.smsmobileapi.com/delete-history-whatsapp-sent/

Tyhjentää palvelimen tiedot lähetetyistä WhatsApp-viesteistä. Se ei poista viestejä WhatsApp keskusteluista.

Milloin sitä käytetään

Käytä ensin esikatselu, tarkista laskut ja pyydä sitten nimenomaisesti poistoa. Tämä tyhjentää API-avaimen koko valitun historian ilman päivämäärää, puhelin- tai viestisuodattimia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Vapaaehtoinen Ei OAuth2. OAuth2, valitkaa valinnaisesti API samaan tiliin kuuluva avain.
action preview | delete | status Vapaaehtoinen preview laskee tietueet poistamatta niitä; delete aloittaa poiston tai jatkaa sitä; status näyttää vain edistymisen. API:n oletus on delete, tämän testaustyökalun oletus on preview.
include_linked 0 | 1 Vapaaehtoinen Oletus 0: säilytetään linkitettyjä tai prosessoituja tietoja. Aseta 1 sisällyttämään ne, jolloin on riski murtaa integraatioita. Säilytä tämä arvo muuttumattomana, kun jatkat poistoa.
request_id jono Vapaaehtoinen Pakollinen toiminnoille delete ja status, valinnainen toiminnolle preview. Käytä 16–128 ASCII-kirjainta, numeroa, yhdysmerkkiä (-) tai alaviivaa (_). Luo jokaiselle uudelle poistolle yksilöllinen tunniste ja säilytä se kaikissa uusintayrityksissä. Tämä ei ole viestin tunniste eikä API-avain.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "whatsapp-sent",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Edellä oleva esimerkki on esikatselu, ei poisto. Laskelmat ovat havainnollisia; lopullinen valinta on vahvistettu poiston alkaessa.
  • include_linked=1 voi häiritä GHL:ää, Zapier:ää, automaatioita, peruuttaa linkit tai seurata toimitusta. Se ei koskaan ohita tilin omistajuuden tai säilytyksen eheyden tarkistuksia.
POST · GET

Tyhjennä vastaanotettujen WhatsApp-viestien historia

#
endpointhttps://api.smsmobileapi.com/delete-history-whatsapp-received/

Tyhjentää vastaanotettujen WhatsApp-viestien palvelimen tiedot. Se ei irrota WhatsApp:ää tai poista keskusteluja.

Milloin sitä käytetään

Käytä ensin esikatselu, tarkista laskut ja pyydä sitten nimenomaisesti poistoa. Tämä tyhjentää API-avaimen koko valitun historian ilman päivämäärää, puhelin- tai viestisuodattimia.

Parametrit

NimiTyyppiVaatimusKuvaus
apikey jono Vapaaehtoinen Ei OAuth2. OAuth2, valitkaa valinnaisesti API samaan tiliin kuuluva avain.
action preview | delete | status Vapaaehtoinen preview laskee tietueet poistamatta niitä; delete aloittaa poiston tai jatkaa sitä; status näyttää vain edistymisen. API:n oletus on delete, tämän testaustyökalun oletus on preview.
include_linked 0 | 1 Vapaaehtoinen Oletus 0: säilytetään linkitettyjä tai prosessoituja tietoja. Aseta 1 sisällyttämään ne, jolloin on riski murtaa integraatioita. Säilytä tämä arvo muuttumattomana, kun jatkat poistoa.
request_id jono Vapaaehtoinen Pakollinen toiminnoille delete ja status, valinnainen toiminnolle preview. Käytä 16–128 ASCII-kirjainta, numeroa, yhdysmerkkiä (-) tai alaviivaa (_). Luo jokaiselle uudelle poistolle yksilöllinen tunniste ja säilytä se kaikissa uusintayrityksissä. Tämä ei ole viestin tunniste eikä API-avain.

Esimerkki pyynnön esittämisestä

cURL
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

POST · API-avain
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET · tila
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

Esimerkkivastaus

JSON
{
    "result": {
        "error": 0,
        "history": "whatsapp-received",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

Haluatko tehdä tämän pyynnön?Yhdistä API-näppäin sivun yläreunaan avataksesi interaktiivisen testin.

Liitä avain ↑
Hyvä tietää
  • Edellä oleva esimerkki on esikatselu, ei poisto. Laskelmat ovat havainnollisia; lopullinen valinta on vahvistettu poiston alkaessa.
  • include_linked=1 voi häiritä GHL:ää, Zapier:ää, automaatioita, peruuttaa linkit tai seurata toimitusta. Se ei koskaan ohita tilin omistajuuden tai säilytyksen eheyden tarkistuksia.

Vianetsintä

Virheet ja turvalliset korjaukset

Lue HTTP- tila ja JSON- virhekenttä ennen kuin yrität uudelleen. Älä yritä uudelleen validointi- tai tunnistusvirheitä korjaamatta ensin pyyntöä.

HTTPKoodiMitä tehdä?
400missing_parameterVaadittu parametri on tyhjä tai puuttuu. Tarkista päätetapahtuman parametritaulukko.
403invalid_apikeyAPI-avain on tuntematon, vanhentunut tai ei ole hyväksytty pyydettyyn ominaisuuteen.
429too_many_requestsPyyntöjä tulee liian nopeasti. -En. Yritä sitten uudelleen.
500server_errorPalvelu ei voinut täyttää pyyntöä. Pidä vastaus ja ota yhteyttä, jos se jatkuu.
Yritä uudelleen sääntöKokeile vain ohimeneviä 429 ja 5xx-vasteita. Aloita 1 sekunnin jälkeen ja peräänny 2, 4 ja 8 sekunnin kuluttua.

Tarvitsetko apua?

Tuo pyyntö kontekstia. Ei salaisuuksia.

Jaa päätepiste, aikaleima, HTTP-status ja puhdistava vaste. Älä koskaan sisälly API-näppäimiin, rahakkeisiin tai yksityiseen viestisisältöön.

Ota yhteyttä API-tukeen →