WhatsApp Business API
  1. Contacts
WhatsApp Business API
  • Registration
    • Request-Code
      POST
    • Register-Account
      POST
  • Application
    • Set-Shards
      POST
    • Reset-Application-Settings
      DELETE
    • Get-Application-Settings
      GET
    • Update-Application-Settings
      PATCH
    • Get-Media-Providers
      GET
    • Update-Media-Providers
      POST
    • Delete-Media-Providers
      DELETE
  • Certificates
    • Upload-Certificate
      POST
    • Download-CA-Certificate
      GET
    • Delete Webhook CA Certificate
      DELETE
    • Download Webhook CA Certificate
      GET
    • Upload Webhook CA Certificate
      POST
  • Contacts
    • Check-Contact
      POST
  • Groups
    • Get-All-Groups
      GET
    • Create-Group
      POST
    • Get-Group-Info
      GET
    • Update-Group-Info
      PUT
    • Demote-Group-Admin
      DELETE
    • Promote-To-Group-Admin
      PATCH
    • Delete-Group-Icon
      DELETE
    • Get-Group-Icon-Binary
      GET
    • Set-Group-Icon
      POST
    • Delete-Group-Invite
      DELETE
    • Get-Group-Invite
      GET
    • Leave-Group
      POST
    • Remove-Group-Participant
      DELETE
  • Health
    • Check-Health
    • Get-Metrics (since v2.21.3)
    • Get-App-Stats
    • Get-DB-Stats
    • Get-Support-Info
  • Media
    • Upload-Media
    • Delete-Media
    • Download-Media
  • Messages
    • Send-Message
    • Mark-Message-As-Read
  • Two-Step Verification
    • Disable-Two-Step
    • Enable-Two-Step
  • Backup
    • Restore
      • Backup-Settings
      • Restore-Settings
  • Business Profile
    • Get-Business-Profile
    • Update-Business-Profile
  • Profile
    • Get-Profile-About
    • Update-Profile-About
    • Get-Profile-Photo
    • Update-Profile-Photo
  • Users
    • Create-User
    • Login-User
    • Logout-User
    • Delete-User
    • Get-User
    • Update-User
  • Delete-Profile-Photo
    DELETE
  1. Contacts

Check-Contact

http://whatsapp.local
http://whatsapp.local
http://whatsapp.local
http://whatsapp.local
POST
/contacts
Contacts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://whatsapp.local/contacts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "blocking": "wait",
    "contacts": [
        "{{Recipient-WA-ID}}"
    ]
}'
Response Response Example
{
  "contacts": [
    {
      "input": "1-631-555-1002",
      "status": "processing"
    },
    {
      "input": "6315551003",
      "status": "processing"
    },
    {
      "input": "+54 9 11 5612-1008",
      "status": "processing"
    },
    {
      "input": "+1 (516) 283-7151",
      "status": "valid",
      "wa_id": "15162837151"
    }
  ]
}

Request

Body Params application/json
blocking
enum<string> 
optional
Blocking determines whether the request should wait for the processing to complete (synchronous) or not (asynchronous).
Allowed values:
no_waitwait
Default:
no_wait
contacts
array[string]
required
Array of contact phone numbers. The numbers can be in any standard telephone number format.
Examples

Responses

🟢200Success
application/json
Body
errors
array[object (Error) {4}] 
optional
Only returned with a failed request. Contains an array of error objects that are present when there is an error.
code
integer <int32>
optional
See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.
details
string 
optional
error detail
href
string 
optional
location for error detail
title
string 
optional
error title
meta
object 
Meta
optional
Contains generic information such as WhatsApp Business API Client version.
Example:
{"api_status":"stable","version":"whatsapp-business-api-client-version"}
api_status
enum<string> 
optional
Allowed values:
deprecatedexperimentalstable
version
string 
optional
contacts
array[object (Check-Contact) {3}] 
optional
input
string 
optional
The value you sent in the contacts field of the JSON request.
status
enum<string> 
optional
Status of the user.
Allowed values:
processingvalidinvalid
wa_id
string 
optional
WhatsApp user identifier that can be used in other API calls. Only returned if the status is valid.
Modified at 2023-08-15 03:06:39
Previous
Upload Webhook CA Certificate
Next
Get-All-Groups
Built with