Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
import { Controller, Put, Delete, Param, Body } from '@nestjs/common';
import { ApiTags, ApiOperation, ApiResponse, ApiParam, ApiBody } from '@nestjs/swagger';
import { ProfileAckResponseDto } from './dto/profile-response.dto';
import { ProfileService } from './profile.service';
import { SetProfileNameDto, SetProfileStatusDto, SetProfilePictureDto } from './dto/profile.dto';
import { RequireRole } from '../auth/decorators/auth.decorators';
import { ApiKeyRole } from '../auth/entities/api-key.entity';
import {
ENGINE_NOT_READY_409,
MEDIA_TOO_LARGE_413,
MEDIA_URL_PROXY_503,
} from '../../common/openapi/engine-status-responses';
@ApiTags('profile')
@Controller('sessions/:sessionId/profile')
export class ProfileController {
constructor(private readonly profileService: ProfileService) {}
@Put('name')
@RequireRole(ApiKeyRole.OPERATOR)
@ApiOperation({ summary: 'Set the account display name' })
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiBody({ type: SetProfileNameDto })
@ApiResponse({ status: 200, description: 'Profile name updated', type: ProfileAckResponseDto })
@ApiResponse({ status: 400, description: 'Session is not started' })
@ApiResponse({
status: 403,
description:
'The whatsapp-web.js engine refused the name change. The Baileys engine has no acceptance ' +
'signal and answers 200 for a rename WhatsApp declined.',
})
@ApiResponse({
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
'the gateway stopped waiting for a confirmation that never came.',
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async setName(@Param('sessionId') sessionId: string, @Body() dto: SetProfileNameDto) {
await this.profileService.setProfileName(sessionId, dto.name);
return { success: true, message: 'Profile name updated' };
}
@Put('status')
@RequireRole(ApiKeyRole.OPERATOR)
@ApiOperation({ summary: 'Set the account about/status text' })
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiBody({ type: SetProfileStatusDto })
@ApiResponse({ status: 200, description: 'Profile status updated', type: ProfileAckResponseDto })
@ApiResponse({ status: 400, description: 'Session is not started' })
@ApiResponse({
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
'the gateway stopped waiting for a confirmation that never came.',
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async setStatus(@Param('sessionId') sessionId: string, @Body() dto: SetProfileStatusDto) {
await this.profileService.setProfileStatus(sessionId, dto.status);
return { success: true, message: 'Profile status updated' };
}
@Put('picture')
@RequireRole(ApiKeyRole.OPERATOR)
@ApiOperation({ summary: 'Set the account profile picture (URL or base64 image)' })
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiBody({ type: SetProfilePictureDto })
@ApiResponse({ status: 200, description: 'Profile picture updated', type: ProfileAckResponseDto })
@ApiResponse({
status: 400,
description:
'Neither url nor base64 provided, base64 without mimetype, session is not started, the url ' +
'answers non-2xx, times out or cannot be reached, or the image cannot be read (Baileys refuses an SVG)',
})
@ApiResponse({
status: 403,
description:
'The whatsapp-web.js engine refused the picture change. The Baileys engine has no acceptance ' +
'signal and answers 200 for an upload WhatsApp declined.',
})
@ApiResponse({ status: 413, description: MEDIA_TOO_LARGE_413 })
@ApiResponse({
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
'the gateway stopped waiting for a confirmation that never came. ' +
MEDIA_URL_PROXY_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async setPicture(@Param('sessionId') sessionId: string, @Body() dto: SetProfilePictureDto) {
await this.profileService.setProfilePicture(sessionId, dto);
return { success: true, message: 'Profile picture updated' };
}
@Delete('picture')
@RequireRole(ApiKeyRole.OPERATOR)
@ApiOperation({ summary: "Remove the account's profile picture" })
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiResponse({ status: 200, description: 'Profile picture removed', type: ProfileAckResponseDto })
@ApiResponse({ status: 400, description: 'Session is not started' })
@ApiResponse({
status: 403,
description:
'The whatsapp-web.js engine refused the picture removal. The Baileys engine has no acceptance ' +
'signal and answers 200 for a removal WhatsApp declined.',
})
@ApiResponse({
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
'the gateway stopped waiting for a confirmation that never came.',
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async deletePicture(@Param('sessionId') sessionId: string) {
await this.profileService.deleteProfilePicture(sessionId);
return { success: true, message: 'Profile picture removed' };
}
}