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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-number-id
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

numberstring required

Phone number in international format without leading + or 00

Example request

{
  "number": "15553334444"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved chat ID.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.