WhatsApp Tools

WhatsApp Number Screening Interface

Note: The maximum number of screenings per request is 20,000, and the minimum is 500. This is a paid interface.

• Type

  API

• URI

  /wscrm-bus-api/open/scan/screenWhatsApp

• Request Method

  POST、Content-Type: application/json

• Interface Description

  Determine if a phone number is a WhatsApp number, if it's active, avatar gender, etc.

• Request Parameter Description

Field	Type	Required	Description
data	List	Yes	Phone numbers (with country code)
type	int	Yes	Screening type 0、is WhatsApp 1、screen active 2、screen avatar gender
activeType	int	No	Active type 0、frequent 1、recent 2、recently
country	String	Yes	Country

Request Example:

{
  "data": ["91182716322323", "91182716322321"],
  "type": 1,
  "activeType": 0,
  "country": "IN"
}

• Response Parameter Description

  Parameter Name	Type	Required	Description
  code	int	Yes	Status code
  message	String	Yes	Description
  data	String	Yes	Order id

• Response Example

{
  "code": 200,
  "message": "Success",
  "data": "330e6b1c1dd62662d0474de6f0003288"
}

Query Screening Task Status Interface

• Type

  API

• URI

  /wscrm-bus-api/open/scan/queryTaskStatus/{orderId}

• Request Method

  POST

• Interface Description

  Query the status of WhatsApp screening task order

• Request Parameter Description

Field	Type	Required	Description
orderId	String	Yes	Order number

• Response Parameter Description

  Parameter Name	Type	Required	Description
  code	int	Yes	Status code
  message	String	Yes	Description
  data	int	Yes	1、completed 0、not completed

• Response Example

{
  "code": 200,
  "message": "Success ",
  "data": 0
}

Query Screening Task Result Interface

• Type

  API

• URI

  /wscrm-bus-api/open/scan/queryTaskDetails/{orderId}

• Request Method

  POST

• Interface Description

  Query detailed information of WhatsApp screening task (prerequisite: screening task is in completed status)

• Request Parameter Description

Field	Type	Required	Description
orderId	String	Yes	Order number

• Response Parameter Description

Parameter Name	Type	Required	Description
code	int	Yes	Status code
message	String	Yes	Description
data	String	Yes	url download address (with validity period)

• Response Example

{
  "code": 200,
  "message": "Success ",
  "data":  "http://aliyun/xxx/yyy/zzz.xlsx"
  ]
}

• xlsx Column Field Explanation

  Parameter Name	Type	Always Has Value	Description
  Phone Number	String	Yes	9119228282828
  Is WhatsApp Number	int	No	1、Yes
  Status	String	No	happy
  Last Active Time	String	No	2025-09-05 00:10:47
  Active Hour	int	No	2
  Avatar	String	No	http://wwww/xxxx/1.png
  Is Business Number	int	No	1、Yes
  Gender	String	No	male(男）、female（女）、unknown
  Age	String	No	22