v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

client

request pairing code

Request a pairing code for phone number registration. To prevent abuse and ensure system stability, pairing code requests are limited to 2 per minute. Multiple rapid requests may indicate automated abuse attempts.

post/instances/{id}/client/action/request-pairing-code

Path parameters

idinteger required

Instance ID

Request body

phoneNumberstring required

Phone number in international format without symbols (e.g. 50664083362)

showNotificationboolean

Whether to show notification when pairing code is received

Example request

{
  "phoneNumber": "50664083362"
}

Response

Successfully retrieved pairing code

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "data": {
      "pairingCode": "ABC-123"
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/request-pairing-code"
  },
  "status": "success"
}