Get Customer ID by phone number

Retrieve the Customer ID(s) using their phone numbers.

This API is subject to a strict limitation of 200 requests per minute.

GET http://api.ants.tech/access/api/profile/get-customer-id-by-phone

Query Parameters

Name Type Description

Name	Type	Description
operator*	String	The operator that you want to use to find your Customer ID, can be one of these operators: - `contains` - `doesnt_contain` - `end_with` - `equals` - `exists` - `matches` - `not_end_with` - `not_equals` - `not_exists` - `not_matches` - `not_start_with` - `start_with`
phone_number	String	The phone number you are getting Customer ID from. This parameter is used for most of the operators, except `exists` and `not_exists`.
phone_number[]	Array of String	The array of phone numbers if you want to get multiple Customer IDs, only applies to the operators `matches` and `not_matches`.
phone_number	null	The special value for the 2 operators `exists` and `not_exists`.
	String	Select pagination (default: 1).
limit	Number	Set the results count (default: 25).

operator*

String

The operator that you want to use to find your Customer ID, can be one of these operators:

- contains

- doesnt_contain

- end_with

- equals

- exists

- matches

- not_end_with

- not_equals

- not_exists

- not_matches

- not_start_with

- start_with

phone_number

String

The phone number you are getting Customer ID from. This parameter is used for most of the operators, except exists and not_exists.

phone_number[]

Array of String

The array of phone numbers if you want to get multiple Customer IDs, only applies to the operators matches and not_matches.

phone_number

null

The special value for the 2 operators exists and not_exists.

String

Select pagination (default: 1).

limit

Number

Set the results count (default: 25).

Headers

Name Type Description

Name	Type	Description
Authorization*	String	Bearer `<ACCESS_TOKEN>`

Authorization*

String

Bearer <ACCESS_TOKEN>

{
    "code": 200,
    "message": "Success",
    "data": {
        "entries": [
            {
                "customer_id": {
                    "value": "84907089782"
                },
                "phone": {
                    "value": "84907089782"
                }
            }
        ],
        "meta": {
            "total": 1
        }
    },
    "codeMessage": null,
    "duration": "1.872 ms"
}

{
    "code": 301,
    "message": "Permission denied",
    "data": "You don't have permission to access this request!"
}

{
  "code": 500,
  "message": "<html>\r\n<head><title>429 Too Many Requests</title></head>\r\n<body bgcolor=\"white\">\r\n<center><h1>429 Too Many Requests</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n",
  "duration": "0.35 ms"
}

PreviousGet Customer Profile NextEvent API

Last updated 11 months ago