green-api/whatsapp-api-client-php

Green-api.com REST API 客户端

v0.2 2023-01-18 10:46 UTC

This package is auto-updated.

Last update: 2024-09-14 05:57:05 UTC


README

Total Downloads Downloads per month License

PHP 库,用于通过 green-api.com 服务的 API 集成 WhatsApp 消息应用。使用此库,您需要在 个人区域 获取注册令牌和账户 ID。提供免费开发者账户套餐计划。

API

您可以通过 此网址 找到 REST API 文档。此库是 REST API 的包装器,因此上述网址的文档也适用于库。

安装

通过 Composer

composer require green-api/whatsapp-api-client-php

导入

require './vendor/autoload.php';

授权

要发送消息或执行其他 Green-API 方法,您必须在手机应用中拥有 WhatsApp 账户进行授权。要授权您的账户,请访问 个人区域 并使用 WhatsApp 应用扫描 QR 码。

运行 index.php

php -S localhost:8080

示例

如何初始化对象

$greenApi = new GreenApiClient( ID_INSTANCE, API_TOKEN_INSTANCE );

向 WhatsApp 号码发送文本消息

$result = $greenApi->sending->sendMessage('11001234567@g.us', 'Message text');

示例 URL: sendTextMessage.php

请注意,密钥可以从环境变量中获取

<?php
require './vendor/autoload.php';

define( "ID_INSTANCE", getenv("ID_INSTANCE" ));
define( "API_TOKEN_INSTANCE", getenv("API_TOKEN_INSTANCE") );

通过 URL 发送图片

$result = $greenApi->sending->sendFileByUrl(
        '11001234567@c.us', 'https://www.google.ru/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png',
        'googlelogo_color_272x92dp.png', 'Google logo');

示例 URL: sendPictureByLink.php

通过从磁盘上传发送图片

$result = $greenApi->sending->sendFileByUpload('11001234567@c.us',
        'C:\Games\PicFromDisk.png', 'PicFromDisk.jpg', 'Picture from disk');

示例 URL: sendPictureByUpload.php

创建群组并向群组发送消息

$chatIds = [
	'11001234567@c.us'
];
$resultCreate = $greenApi->groups->createGroup('GroupName', $chatIds );

if ($resultCreate->code == 200)
	$resultSend = $greenApi->sending->sendMessage($resultCreate->data->chatId, 
	    'Message text');

重要:如果尝试使用不存在的号码创建群组,WhatsApp 可能会阻止发送者的号码。示例中的号码是不存在的。

示例 URL: createGroupAndSendMessage.php

通过 HTTP API 接收传入的消息

Green API 接收数据的一般概念在 此处 描述。要开始通过 HTTP API 接收消息,需要执行库方法

greenAPI.webhooks.startReceivingNotifications(onEvent)

onEvent - 应包含参数的您的函数

消息正文类型和格式 此处

当接收到传入消息时,将调用此方法。接下来,根据您的系统业务逻辑处理消息。

示例列表

库方法的完整列表

服务方法文档

https://green-api.com/en/docs/api/

许可证

根据 MIT 许可证授权。请参阅文件 LICENSE