Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
<?php
declare(strict_types=1);
namespace OpenWA\Tests;
use OpenWA\Exceptions\OpenWANotFoundException;
use PHPUnit\Framework\TestCase;
class MessagesTest extends TestCase
{
public function testSendTextUsesSendTextPath(): void
{
$backend = (new MockBackend())->on(201, ['messageId' => 'm1', 'timestamp' => 1]);
$client = $backend->makeClient();
$client->messages->sendText('s1', ['chatId' => '[email protected]', 'text' => 'hi']);
$call = $backend->lastCall();
// Guzzle exposes the relative path at the handler layer; the host is
// statically configured via base_uri, so we assert on path + body.
$this->assertSame('/api/sessions/s1/messages/send-text', $call['path']);
$this->assertSame(['chatId' => '[email protected]', 'text' => 'hi'], $call['body']);
}
public function testSendTextForwardsMentionsVerbatim(): void
{
$backend = (new MockBackend())->on(201, ['messageId' => 'm1', 'timestamp' => 1]);
$client = $backend->makeClient();
$client->messages->sendText('s1', ['chatId' => '[email protected]', 'text' => 'hi @628123', 'mentions' => ['[email protected]']]);
$this->assertSame(
['chatId' => '[email protected]', 'text' => 'hi @628123', 'mentions' => ['[email protected]']],
$backend->lastCall()['body']
);
}
public function testSendPollUsesSendPollPath(): void
{
$backend = (new MockBackend())->on(201, ['messageId' => 'm2', 'timestamp' => 2]);
$client = $backend->makeClient();
$res = $client->messages->sendPoll('s1', [
'chatId' => '[email protected]',
'name' => 'Where?',
'options' => ['Park', 'Beach'],
'allowMultipleAnswers' => true,
]);
$call = $backend->lastCall();
$this->assertSame('/api/sessions/s1/messages/send-poll', $call['path']);
$this->assertSame(
['chatId' => '[email protected]', 'name' => 'Where?', 'options' => ['Park', 'Beach'], 'allowMultipleAnswers' => true],
$call['body']
);
$this->assertSame('m2', $res['messageId']);
}
public function testListReturnsMessagesPageEnvelope(): void
{
// The server responds with a {messages, total} page, not a flat array. Pin the shape so a
// future change — or a misunderstood "fix" that unwraps it and drops `total` — is caught.
$backend = (new MockBackend())->on(200, [
'messages' => [['id' => 'm1', 'body' => 'hi', 'chatId' => '[email protected]']],
'total' => 1,
'unknownTimestampTotal' => 2,
]);
$client = $backend->makeClient();
$page = $client->messages->list('s1', [
'limit' => 10, 'since' => 1789855200000.5, 'until' => 1789941600000,
'direction' => 'incoming', 'orderBy' => 'timestamp', 'type' => 'image', 'messageId' => 'M1',
]);
$this->assertArrayHasKey('messages', $page);
$this->assertIsArray($page['messages']);
$this->assertSame('m1', $page['messages'][0]['id']);
$this->assertSame(1, $page['total']);
$this->assertStringContainsString('/messages', $backend->lastCall()['path']);
$this->assertStringContainsString('limit=10', $backend->lastCall()['query']);
foreach (['since=1789855200000.5', 'until=1789941600000', 'direction=incoming', 'orderBy=timestamp', 'type=image', 'messageId=M1'] as $field) {
$this->assertStringContainsString($field, $backend->lastCall()['query']);
}
$this->assertSame(2, $page['unknownTimestampTotal']);
}
public static function mediaSegments(): array
{
return [
'sendImage' => ['sendImage', 'send-image'],
'sendVideo' => ['sendVideo', 'send-video'],
'sendAudio' => ['sendAudio', 'send-audio'],
'sendDocument' => ['sendDocument', 'send-document'],
'sendSticker' => ['sendSticker', 'send-sticker'],
];
}
/**
* @dataProvider mediaSegments
*/
public function testMediaSegmentsUseCorrectPaths(string $method, string $segment): void
{
$backend = (new MockBackend())->on(201, ['messageId' => 'm', 'timestamp' => 2]);
$client = $backend->makeClient();
$client->messages->$method('s', ['chatId' => '[email protected]', 'url' => 'u']);
$this->assertStringContainsString("/messages/{$segment}", $backend->lastCall()['path']);
}
public function testReplyForwardReactDelete(): void
{
$backend = new MockBackend();
$backend->on(201, ['messageId' => 'm', 'timestamp' => 1]);
$backend->on(201, ['messageId' => 'm', 'timestamp' => 1]);
$backend->on(201, ['messageId' => 'm', 'timestamp' => 1]);
$backend->on(200, ['success' => true]);
$backend->on(200, ['success' => true]);
$client = $backend->makeClient();
$client->messages->reply('s', ['chatId' => '[email protected]', 'quotedMessageId' => 'q', 'text' => 'r']);
$this->assertStringContainsString('/messages/reply', $backend->calls()[0]['url']);
$client->messages->clickButton('s', ['chatId' => '[email protected]', 'messageId' => 'p', 'buttonId' => 'yes', 'text' => 'Sim']);
$this->assertStringContainsString('/messages/click-button', $backend->calls()[1]['url']);
$client->messages->forward('s', ['fromChatId' => '[email protected]', 'toChatId' => '[email protected]', 'messageId' => 'm']);
$this->assertStringContainsString('/messages/forward', $backend->calls()[2]['url']);
$client->messages->react('s', ['chatId' => '[email protected]', 'messageId' => 'm', 'emoji' => '👍']);
$this->assertStringContainsString('/messages/react', $backend->calls()[3]['url']);
$client->messages->delete('s', ['chatId' => '[email protected]', 'messageId' => 'm']);
$this->assertStringContainsString('/messages/delete', $backend->calls()[4]['url']);
}
/**
* This client takes an untyped array, so nothing here checks the shape at compile time — the
* body assertion is the only thing standing between a caller and a silently dropped key.
*/
public function testQuotedMessageIdReachesTheBodyOnEverySend(): void
{
$backend = new MockBackend();
foreach (range(1, 5) as $ignored) {
$backend->on(201, ['messageId' => 'm', 'timestamp' => 1]);
}
$client = $backend->makeClient();
$client->messages->sendText('s', ['chatId' => '[email protected]', 'text' => 'hi', 'quotedMessageId' => 'q1']);
$client->messages->sendImage('s', ['chatId' => '[email protected]', 'url' => 'http://u', 'quotedMessageId' => 'q1']);
$client->messages->sendLocation(
's',
['chatId' => '[email protected]', 'latitude' => 1, 'longitude' => 2, 'quotedMessageId' => 'q1']
);
$client->messages->sendContact(
's',
['chatId' => '[email protected]', 'contactName' => 'A', 'contactNumber' => '628', 'quotedMessageId' => 'q1']
);
$client->messages->sendPoll(
's',
['chatId' => '[email protected]', 'name' => 'Q', 'options' => ['a', 'b'], 'quotedMessageId' => 'q1']
);
foreach ($backend->calls() as $call) {
$this->assertSame('q1', $call['body']['quotedMessageId'] ?? null, $call['url']);
}
}
public function testOrdinarySendCarriesNoQuoteKey(): void
{
$backend = new MockBackend();
$backend->on(201, ['messageId' => 'm', 'timestamp' => 1]);
$backend->makeClient()->messages->sendImage('s', ['chatId' => '[email protected]', 'url' => 'http://u']);
$this->assertArrayNotHasKey('quotedMessageId', $backend->lastCall()['body']);
}
public function testEditMessageUsesEditPath(): void
{
$backend = (new MockBackend())->on(200, ['messageId' => 'm1', 'timestamp' => 123]);
$client = $backend->makeClient();
$result = $client->messages->editMessage('s1', ['chatId' => '[email protected]', 'messageId' => 'm1', 'body' => 'edited']);
$call = $backend->lastCall();
$this->assertSame('POST', $call['method']);
$this->assertSame('/api/sessions/s1/messages/edit', $call['path']);
$this->assertSame(['chatId' => '[email protected]', 'messageId' => 'm1', 'body' => 'edited'], $call['body']);
$this->assertSame('m1', $result['messageId']);
}
public function testEditMessage404MapsToNotFoundException(): void
{
$backend = (new MockBackend())->on(404, [
'statusCode' => 404,
'message' => 'Message not found',
'error' => 'Not Found',
]);
$this->expectException(OpenWANotFoundException::class);
$backend->makeClient()->messages->editMessage('s1', ['chatId' => '[email protected]', 'messageId' => 'missing', 'body' => 'x']);
}
public function testHistoryAndReactionsPath(): void
{
$backend = new MockBackend();
$backend->on(200, []);
$backend->on(200, []);
$client = $backend->makeClient();
$client->messages->history('s', '[email protected]', ['limit' => 5]);
$this->assertStringContainsString('/messages/[email protected]/history', $backend->calls()[0]['url']);
$this->assertStringContainsString('limit=5', $backend->calls()[0]['url']);
$client->messages->reactions('s', '[email protected]', 'm1');
$this->assertStringContainsString('/messages/[email protected]/m1/reactions', $backend->calls()[1]['url']);
}
public function testSendBulkBatchStatusCancelBatch(): void
{
$backend = new MockBackend();
$backend->on(202, ['batchId' => 'b', 'status' => 'queued', 'totalMessages' => 1, 'estimatedCompletionTime' => 't', 'statusUrl' => '/u']);
$backend->on(200, ['batchId' => 'b', 'status' => 'done', 'progress' => 100, 'results' => [], 'startedAt' => 's', 'completedAt' => 'c']);
$backend->on(200, ['batchId' => 'b', 'status' => 'cancelled', 'progress' => 50]);
$client = $backend->makeClient();
$client->messages->sendBulk('s', ['messages' => [['chatId' => '[email protected]', 'type' => 'text', 'content' => ['text' => 'x']]]]);
$this->assertStringContainsString('/messages/send-bulk', $backend->calls()[0]['url']);
$status = $client->messages->batchStatus('s', 'b');
$this->assertSame(100, $status['progress']);
$this->assertStringContainsString('/messages/batch/b', $backend->calls()[1]['url']);
$cancelled = $client->messages->cancelBatch('s', 'b');
$this->assertSame('cancelled', $cancelled['status']);
$this->assertSame('POST', $backend->calls()[2]['method']);
$this->assertStringContainsString('/messages/batch/b/cancel', $backend->calls()[2]['url']);
}
}