Langkau ke kandungan
WbizTool

API v2 (beta)

Nombor

Nombor ialah nombor WhatsApp atau akaun Telegram yang disambungkan ke ruang kerja anda. id-nya ialah from yang anda gunakan untuk menghantar mesej. Dengan API v2, anda boleh menyenaraikannya, melihat sama ada setiap satu disambungkan, dan menyambungkan nombor WhatsApp dari aplikasi anda sendiri, dengan kod QR atau kod pautan.

OperasiEndpointSkop
Senaraikan nomborGET /api/v2/numbersnumbers
Dapatkan nomborGET /api/v2/numbers/{id}numbers
Sambungkan nombor WhatsAppPOST /api/v2/numbersnumbers

Kunci yang dihadkan kepada sebahagian nombor hanya melihat dan menyambungkan semula nombor itu, dan tidak boleh menambah nombor.

Senaraikan nombor#

GEThttps://wbiztool.com/api/v2/numbers

Semua nombor ruang kerja, yang tertua dahulu, dalam satu senarai data (tanpa halaman).

curl https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    {
      "id": 101,
      "phone": "919800000000",
      "label": "Shop",
      "platform": "whatsapp",
      "status": "connected",
      "login_method": "qr",
      "connect": null
    },
    {
      "id": 102,
      "phone": null,
      "label": "",
      "platform": "whatsapp",
      "status": "disconnected",
      "login_method": "qr",
      "connect": null
    }
  ]
}

connect sentiasa null dalam senarai. Untuk mengikuti sambungan, dapatkan nombor itu.

Dapatkan nombor#

GEThttps://wbiztool.com/api/v2/numbers/{id}

Satu nombor. Semasa ia sedang disambungkan, connect mengandungi kod QR untuk diimbas atau kod pautan untuk ditaip.

curl https://wbiztool.com/api/v2/numbers/102 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 102,
  "phone": null,
  "label": "",
  "platform": "whatsapp",
  "status": "connecting",
  "login_method": "qr",
  "connect": {
    "qr_code_url": "https://…/qr_codes/…png?X-Amz-Signature=…",
    "pairing_code": null,
    "pairing_code_expires_at": null,
    "linking": false,
    "requested_at": "2026-10-18T11:02:15.402Z"
  }
}

Nombor yang tidak wujud, atau yang tidak boleh digunakan oleh kunci, menjawab 404 number_not_found.

Objek Number#

MedanJenisPenerangan
idintegerID nombor: from bagi mesej atau peringatan.
phonestring or nullDigitnya dengan kod negara, tanpa +, seperti 919800000000. null bagi nombor baharu yang disambungkan dengan QR sehingga kod QR diimbas.
labelstringNamanya dalam papan pemuka; "" apabila tiada.
platformstringwhatsapp atau telegram.
statusstringconnected, connecting (sambungan diminta dalam 10 minit yang lalu dan masih berjalan) atau disconnected.
login_methodstringCara ia bersambung: qr atau phone_code (kod pautan).
connectobject or nullSemasa status ialah connecting, dan hanya daripada Dapatkan nombor; jika tidak, null.

connect mengandungi:

MedanJenisPenerangan
qr_code_urlstring or nullPautan ke imej kod QR untuk diimbas. Setiap panggilan memberikan pautan baharu, sah selama 10 minit; null sehingga pelayan mempunyai kod QR.
pairing_codestring or nullBagi phone_code: kod untuk ditaip pada telefon. null sehingga ia sedia.
pairing_code_expires_atstring or nullBila kod pautan berhenti berfungsi.
linkingbooleantrue setelah kod QR diimbas atau kod diterima, semasa WhatsApp menyelesaikan pemautan.
requested_atstring or nullBila sambungan diminta.

Mesej yang dihantar dengan nombor disconnected sebagai from masih diterima: ia menunggu dan dihantar apabila nombor disambungkan semula. Peristiwa webhook untuk nombor akan datang kemudian; sehingga itu, tinjau GET /numbers untuk mengesan nombor yang telah log keluar.

Sambungkan nombor WhatsApp#

POSThttps://wbiztool.com/api/v2/numbers

Body: JSON (application/json)

Meminta pelayan WbizTool membuka WhatsApp untuk sesuatu nombor, supaya anda boleh memautkannya dari aplikasi atau laman web anda sendiri, seperti di halaman Nombor WhatsApp. Responsnya ialah 202 dengan Number, berstatus connecting. Kemudian tinjau ia sehingga ia connected.

Ia memerlukan pelan yang merangkumi API kod QR; jika tidak, ia menjawab 403 plan_required. Akaun Telegram disambungkan dalam papan pemuka, bukan di sini.

Badan

login_methodstringpilihan

qr (lalai): imbas kod QR. phone_code: taip kod pautan pada telefon sebaliknya, berguna apabila telefon ialah satu-satunya skrin.

phonestringWajib untuk phone_code

Nombor WhatsApp untuk dipautkan, dalam format antarabangsa dengan +, seperti +919876543210. Tidak digunakan dengan qr: nombor dibaca daripada WhatsApp selepas imbasan.

number_idintegerpilihan

Sambungkan semula nombor sedia ada ini dan bukannya menambah nombor baharu, contohnya selepas ia log keluar.

# By QR code
curl -X POST https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"login_method": "qr"}'

# By pairing code, reconnecting number 101
curl -X POST https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"login_method": "phone_code", "phone": "+919876543210", "number_id": 101}'

Aliran sambungan#

  1. Minta sambungan

    POST /numbers dengan login_method (dan phone untuk kod pautan). Simpan id daripada respons. Hantar Idempotency-Key supaya cubaan semula tidak meminta dua kali.

  2. Tinjau nombor setiap beberapa saat

    GET /numbers/{id} setiap 2 hingga 5 saat semasa status ialah connecting. Kod QR atau kod pautan muncul dalam connect dalam beberapa saat; sehingga itu medannya ialah null.

  3. Paparkan kod QR atau kod pautan

    QR: paparkan imej di connect.qr_code_url; pada telefon, buka WhatsApp → Peranti dipaut → Paut peranti dan imbasnya. Setiap pautan berfungsi selama 10 minit dan pautan baharu datang dengan setiap tinjauan, jadi paparkan yang terbaharu setiap kali. Kod pautan: pada telefon, buka WhatsApp → Peranti dipaut → Paut peranti → Paut dengan nombor telefon, dan taip connect.pairing_code 8 aksara sebelum connect.pairing_code_expires_at (kira-kira 3 minit).

  4. Tunggu sehingga disambungkan

    Selepas imbasan atau kod, connect.linking ialah true semasa WhatsApp menyelesaikan pemautan. Kemudian status menjadi connected dan phone menunjukkan nombor itu. Berhenti meninjau.

Jika tiada apa-apa berlaku selama 10 minit, percubaan itu tamat dan status kembali kepada disconnected. Minta semula dengan POST /numbers dan number_id-nya.

Semasa sesuatu nombor sedang disambungkan, permintaan lain untuknya menjawab 409 connect_in_progress dengan number_id-nya: teruskan meninjau nombor itu sebaliknya.

Ralat semasa menyambung#

HTTPKodBila
400validation_failedlogin_method bukan qr atau phone_code, atau phone_code tanpa phone
403plan_requiredPelan tidak merangkumi API kod QR
403number_limit_reachedPelan tiada ruang untuk nombor lain
403number_not_allowedKunci dihadkan kepada sebahagian nombor, dan number_id bukan salah satu daripadanya (atau tiada)
409already_connectedNombor itu sudah disambungkan
409connect_in_progressNombor itu sedang disambungkan sekarang; number_id menyatakan yang mana
422invalid_phonephone bukan nombor yang sah dalam format antarabangsa dengan +
422number_not_foundnumber_id bukan nombor ruang kerja ini

Berkaitan#