Check if phone number is suppressed

Description

Checks if a phone number is in a suppression list.

Request URL

Method: POST

https://example.com/api/v1.1/suppresses/phone_check

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
value	string	"+79000000001"	Yes	Phone number to check
format	string	"json"	No	Response data format By default – json
id	int	1	Yes	Suppression list ID

Request example

JSON

{
    "id":1,
    "token":"abcdefghijklmnqrstuvwxyz",
    "value":"+79000000001"
}

XML

<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <value>+79000000001</value>
</xml>

Response example

JSON

{
    "domain_matched": false,
    "email_matched": false,
    "error": 0,
    "error_text": "Successful operation",
    "matched": true,
    "phone_matched": true
}

XML

<result>
  <domain_matched>false</domain_matched>
  <email_matched>false</email_matched>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <matched>true</matched>
  <phone_matched>true</phone_matched>
</result>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
domain_matched	bool	true, if value is in the suppressed domains list
email_matched	bool	true, if value is in the suppressed emails list
phone_matched	bool	true, if value is in the list of suppressed phone numbers
matched	bool	true, if value is in the suppressed emails, domains or phones list