Check if the customer has granted calling permission

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

CheckConsent

post

Body

oa_idstring · int64Optional

phonestringOptional

Responses

post

HTTPcURLJavaScriptPython

POST /CheckConsent HTTP/1.1
Host: $BASE_URL.Zalo
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "oa_id": "text",
  "phone": "text"
}

200

A successful response

{
  "error": 1,
  "expired_time": "2025-04-28T10:32:27.900Z",
  "message": "text"
}

Request:

curl --location '$BASE_URL.Zalo/CheckConsent' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "oa_id": "<int64>",
  "phone": "<string>"
}'

Response:

{
  "error": 0,
  "expired_time": "2019-08-24T14:15:22Z",
  "message": "string"
}

Request body structure

Parameters	Data type	Describe
id	int64	OA ID
phone	string	Recipient phone number

Return data attribute structure

Parameters	Data type	Describe
error_code	int	Error code
message	string	Error message
expired_time	string<date-time>	Expiration date