v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
number

get chat ID from phone number

Converts a phone number into the proper chat ID format. This is especially useful for countries that don't follow the standard chat ID format (like Brazil, Mexico and Argentina). The endpoint ensures you get the correct chat ID for any phone number.

post/instances/{id}/client/action/get-number-id

Path parameters

idinteger required

Instance ID

Request body

numberstring required

Phone number in international format without leading + or 00

Example request

{
  "number": "15553334444"
}

Response

Successfully retrieved chat ID

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "instanceId": "1",
    "data": {
      "numberId": {
        "server": "c.us",
        "user": "15553334444",
        "_serialized": "15553334444@c.us"
      }
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-number-id"
  },
  "status": "success"
}