Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(contact): describe profilePicUrl as the URL Baileys now reports

Yudhi Armyndharisef26ba2bc9b0
diff --git a/openapi.json b/openapi.json
index a94314806..8ab73c7bf 100644
--- a/openapi.json
+++ b/openapi.json
@@ -22401,8 +22401,8 @@
},
"profilePicUrl": {
"type": "string",
- "description": "Not a usable URL. On Baileys it holds only the picture-change marker `changed` or `removed` from a contact notification; whatsapp-web.js never sets it. Neither its value nor its absence says whether the contact has a picture; fetch the URL from GET /contacts/{contactId}/profile-picture.",
- "example": "changed"
+ "description": "A cached profile picture URL. Only Baileys can fill it (whatsapp-web.js never sets it), and it is often absent there too, so its absence does not say whether the contact has a picture; fetch the URL from GET /contacts/{contactId}/profile-picture.",
+ "example": "https://pps.whatsapp.net/v/..."
}
},
"required": [
diff --git a/src/modules/contact/dto/contact-response.dto.ts b/src/modules/contact/dto/contact-response.dto.ts
index 3fc90d64b..7de0db465 100644
--- a/src/modules/contact/dto/contact-response.dto.ts
+++ b/src/modules/contact/dto/contact-response.dto.ts
@@ -37,10 +37,10 @@ export class ContactDto {
@ApiPropertyOptional({
description:
- 'Not a usable URL. On Baileys it holds only the picture-change marker `changed` or `removed` from a ' +
- 'contact notification; whatsapp-web.js never sets it. Neither its value nor its absence says whether ' +
- 'the contact has a picture; fetch the URL from GET /contacts/{contactId}/profile-picture.',
- example: 'changed',
+ 'A cached profile picture URL. Only Baileys can fill it (whatsapp-web.js never sets it), and it is often ' +
+ 'absent there too, so its absence does not say whether the contact has a picture; fetch the URL from ' +
+ 'GET /contacts/{contactId}/profile-picture.',
+ example: 'https://pps.whatsapp.net/v/...',
})
profilePicUrl?: string;
}