zaloplatform/zalo-php-sdk

为 Zalo 开发者提供的 SDK

维护者

详细信息

github.com/zaloplatform/zalo-php-sdk

源代码

问题

安装次数: 94 172

依赖: 2

建议者: 0

安全: 0

星标: 61

关注者: 3

分支: 41

开放问题: 16

类型:项目

4.0.4 2023-12-20 09:36 UTC

Requires

  • php: >=5.4

Requires (Dev)

MIT 6bacb1bea670ce1fa9f1ae616bbbfd92742e20aa

  • zaloplatform <zaloplatform.woop@gmail.com>

composersdkzalozalosdk

This package is auto-updated.

Last update: 2024-09-20 11:21:48 UTC

README

着陆页: https://developers.zalo.me/
博客: 我们在官方 Zalo 平台博客发布了大量优秀的教程和指南，并且我们正在持续添加新内容。
社区: 如果你在使用某些功能时遇到困难，最好的方法是访问Zalo 社区
支持: 我们还可以在开发者官方账号上回答有关 Zalo 的一些简短问题

安装

可以使用 Composer 安装 Zalo PHP SDK。运行以下命令

composer require zaloplatform/zalo-php-sdk

如何使用

导入自动加载 

require_once __DIR__ . '/vendor/autoload.php';

初始化

use Zalo\Zalo;

$config = array(
    'app_id' => '1234567890987654321',
    'app_secret' => 'AbC123456XyZ'
);
$zalo = new Zalo($config);

社交 API

详细文档 在此。
创建 code verifier 和 code challenge 的代码示例 在此。

获取登录链接

$helper = $zalo -> getRedirectLoginHelper();
$callbackUrl = "https://www.callbackack.com";
$codeChallenge = "your code challenge";
$state = "your state";
$loginUrl = $helper->getLoginUrl($callbackUrl, $codeChallenge, $state); // This is login url

获取访问令牌

当用户点击登录链接时，系统将处理用户的登录并重定向到已与应用程序注册的回调链接，OAuth 代码将被返回并显示在回调链接的路径上。请将以下代码放在已与应用程序注册的回调链接上，代码将从回调链接中获取 OAuth 代码并将请求发送到系统以获取访问令牌。

$codeVerifier = "your code verifier";
$zaloToken = $helper->getZaloToken($codeVerifier); // get zalo token
$accessToken = $zaloToken->getAccessToken();

获取用户信息

$accessToken = 'put_your_access_token_here';
$params = ['fields' => 'id,name,picture'];
$response = $zalo->get(ZaloEndPoint::API_GRAPH_ME, $accessToken, $params);
$result = $response->getDecodedBody(); // result

官方账号开放 API

详细文档 在此。
创建 code verifier 和 code challenge 的代码示例 在此。

创建官方账号授权链接

$oaCallbackUrl = "https://www.callbackPage.com"
$codeChallenge = "your code challenge";
$state = "your state";
$linkOAGrantPermission2App = $helper->getLoginUrlByOA($oaCallbackUrl, $codeChallenge, $state); // This is url for admin OA grant permission to app

获取访问令牌

当 OA 管理员点击链接并授权应用程序时，系统将执行处理并重定向到已与应用程序注册的回调链接，OAuth 代码将被返回并显示在回调链接的路径上。请将以下代码放在已与应用程序注册的回调链接上，代码将从回调链接中获取 OAuth 代码并将请求发送到系统以获取访问令牌。

$codeVerifier = "your code verifier";
$zaloToken = $helper->getZaloTokenByOA($codeVerifier); // get zalo token
$accessToken = $zaloToken->getAccessToken();

发送文本咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_TXT);
$msgBuilder->withUserId('user_id');
$msgBuilder->withText('Message Text');

$msgText = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgText);
$result = $response->getDecodedBody();

发送带图片的咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_MEDIA);
$msgBuilder->withUserId('user_id');
$msgBuilder->withText('Message Image');
$msgBuilder->withMediaUrl('https://stc-developers.zdn.vn/images/bg_1.jpg');

$msgImage = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgImage);
$result = $response->getDecodedBody();

发送基于用户信息请求的模板咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_REQUEST_USER_INFO);
$msgBuilder->withUserId('user_id');

$element = array(
    "title" => "OA Chatbot (Testing)",
    "subtitle" => "Đang yêu cầu thông tin từ bạn",
    "image_url" => "https://stc-oa-chat-adm.zdn.vn/images/request-info-banner.png"
);
$msgBuilder->addElement($element);

$msgText = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgText);
$result = $response->getDecodedBody();

发送带文件的咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_FILE);
$msgBuilder->withUserId('user_id');
$msgBuilder->withFileToken('PkkPJZzjmrbliDeEQ6h6MYVxrmrkSenF8A3N0MGpcWailOnLPpZDM7lbsG9YRSe8VxEG0MSuqmv_l945R3NM2d6vb0ThDhvQCgUYKo1vW0nwlRO6EdUnNoQWeo5sUUTqA8JM7cXHuNPqeiK81569QLtRcHSWEDWUFBQO7aa-taK6vvn473xS7m2xa1ySCzmUL-wR54mpYaXGxfj0CIgyTJWa8vW6');
$msgFile = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgFile);
$result = $response->getDecodedBody();

发送引用咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_TXT);
$msgBuilder->withUserId('user_id');

$msgBuilder->withText("quote message");
$msgBuilder->withQuoteMessage('93f8c4b28f589705ce4a');

$msgText = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgText);
$result = $response->getDecodedBody();

发送带 Sticker 的咨询信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_MEDIA);
$msgBuilder->withUserId('user_id');
$msgBuilder->withText('text');
$msgBuilder->withMediaType('sticker');
$msgBuilder->withAttachment('bfe458bf64fa8da4d4eb');

$msgSticker = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_CONSULTATION_MESSAGE_V3, $this->accessToken, $msgSticker);
$result = $response->getDecodedBody();

发送交易信息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_TRANSACTION);
$msgBuilder->withUserId('user_id');

$msgBuilder->withTemplateType(TransactionTemplateType::TRANSACTION_ORDER);
$msgBuilder->withLanguage("VI");

$bannerElement = array(
    'attachment_id' => 'a-JJEvLdkcEPxTOwb6gYTfhwm26VSBHjaE3MDfrWedgLyC0smJRiA8w-csdGVg1cdxZLPT1je7k4i8nwbdYrSCJact3NOVGltEUQTjDayIhTvf1zqsR-Ai3aboRERgjvm-cI8iqv-NoIxi0cdNBoE6SYVJooM6xKTBft',
    'type' => 'banner'
);
$msgBuilder->addElement($bannerElement);

$headerElement = array(
    'content' => 'Trạng thái đơn hàng',
    'align' => 'left',
    'type' => 'header'
);
$msgBuilder->addElement($headerElement);

$text1Element = array(
    'align' => 'left',
    'content' => '• Cảm ơn bạn đã mua hàng tại cửa hàng.<br>• Thông tin đơn hàng của bạn như sau:',
    'type' => 'text'
);
$msgBuilder->addElement($text1Element);

$tableContent1 = array(
    'key' => 'Mã khách hàng',
    'value' => 'F-01332973223'
);
$tableContent2 = array(
    'key' => 'Trạng thái',
    'value' => 'Đang giao',
    'style' => 'yellow',
);
$tableContent3 = array(
    'key' => 'Giá tiền',
    'value' => '250,000đ'
);
$tableElement = array(
    'content' => array($tableContent1, $tableContent2, $tableContent3),
    'type' => 'table'
);
$msgBuilder->addElement($tableElement);

$text2Element = array(
    'content' => 'Lưu ý điện thoại. Xin cảm ơn!',
    'align' => 'center',
    'type' => 'text'

);
$msgBuilder->addElement($text2Element);

$actionOpenUrl = $msgBuilder->buildActionOpenURL('https://oa.zalo.me/home');
$msgBuilder->addButton('Kiểm tra lộ trình - default icon', '', $actionOpenUrl);

$actionQueryShow = $msgBuilder->buildActionQueryShow('Xem lại giỏ hàng');
$msgBuilder->addButton('Xem lại giỏ hàng', 'wZ753VDsR4xWEC89zNTsNkGZr1xsPs19vZF22VHtTbxZ8zG9g24u3FXjZrQvQNH2wMl1MhbwT5_oOvX5_szXLB8tZq--TY0Dhp61JRfsAWglCej8ltmg3xC_rqsWAdjRkctG5lXzAGVlQe9BhZ9mJcSYVIDsc7MoPMnQ', $actionQueryShow);

$actionOpenPhone = $msgBuilder->buildActionOpenPhone('84123456789');
$msgBuilder->addButton('Liên hệ tổng đài', 'gNf2KPUOTG-ZSqLJaPTl6QTcKqIIXtaEfNP5Kv2NRncWPbDJpC4XIxie20pTYMq5gYv60DsQRHYn9XyVcuzu4_5o21NQbZbCxd087DcJFq7bTmeUq9qwGVie2ahEpZuLg2KDJfJ0Q12c85jAczqtKcSYVGJJ1cZMYtKR', $actionOpenPhone);

$msgTransaction = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_TRANSACTION_MESSAGE_V3, $this->accessToken, $msgTransaction);
$result = $response->getDecodedBody();

发送个人消息

$msgBuilder = new MessageBuilder(MessageBuilder::MSG_TYPE_PROMOTION);
$msgBuilder->withUserId('user_id');

$bannerElement = array(
    'attachment_id' => 'aERC3A0iYGgQxim8fYIK6fxzsXkaFfq7ZFRB3RCyZH6RyziRis3RNydebK3iSPCJX_cJ3k1nW1EQufjN_pUL1f6Ypq3rTef5nxp6H_HnXKFDiyD5y762HS-baqRpQe5FdA376lTfq1sRyPr8ypd74ecbaLyA-tGmuJ-97W',
    'type' => 'banner'
);
$msgBuilder->addElement($bannerElement);

$headerElement = array(
    'content' => '💥💥Ưu đãi thành viên Platinum💥💥',
    'type' => 'header'
);
$msgBuilder->addElement($headerElement);

$text1Element = array(
    'content' => 'Ưu đãi dành riêng cho khách hàng Nguyen Van A hạng thẻ Platinum<br>Voucher trị giá 150$',
    'type' => 'text',
    'align' => 'left'

);
$msgBuilder->addElement($text1Element);

$tableContent1 = array(
    'key' => 'Voucher',
    'value' => 'VC09279222'
);
$tableContent2 = array(
    'key' => 'Hạn sử dụng',
    'value' => '30/12/2023'
);
$tableElement = array(
    'content' => array($tableContent1, $tableContent2),
    'type' => 'table'
);
$msgBuilder->addElement($tableElement);

$text2Element = array(
    'content' => 'Áp dụng tất cả cửa hàng trên toàn quốc',
    'type' => 'text',
    'align' => 'center'

);
$msgBuilder->addElement($text2Element);

$actionOpenUrl = $msgBuilder->buildActionOpenURL('https://oa.zalo.me/home');
$msgBuilder->addButton('Tham khảo chương trình', '', $actionOpenUrl);

$actionQueryShow = $msgBuilder->buildActionQueryHide('#tuvan');
$msgBuilder->addButton('Liên hệ chăm sóc viên', 'aeqg9SYn3nIUYYeWohGI1fYRF3V9f0GHceig8Ckq4WQVcpmWb-9SL8JLPt-6gX0QbTCfSuQv40UEst1imAm53CwFPsQ1jq9MsOnlQe6rIrZOYcrlWBTAKy_UQsV9vnfGozCuOvFfIbN5rcXddFKM4sSYVM0D50I9eWy3', $actionQueryShow);

$msgPromotion = $msgBuilder->build();

// send request
$response = $this->zalo->post(ZaloEndPoint::API_OA_SEND_PROMOTION_MESSAGE_V3, $this->accessToken, $msgPromotion);
$result = $response->getDecodedBody();

发送文本消息

// build data
$msgBuilder = new MessageBuilder('text');
$msgBuilder->withUserId('494021888309207992');
$msgBuilder->withText('Message Text');

// add buttons (only support 5 buttons - optional)
$actionOpenUrl = $msgBuilder->buildActionOpenURL('https://wwww.google.com'); // build action open link
$msgBuilder->withButton('Open Link', $actionOpenUrl);

$actionQueryShow = $msgBuilder->buildActionQueryShow('query_show'); // build action query show
$msgBuilder->withButton('Query Show', $actionQueryShow);

$actionQueryHide = $msgBuilder->buildActionQueryHide('query_hide'); // build action query hide
$msgBuilder->withButton('Query Hide', $actionQueryHide);

$actionOpenPhone = $msgBuilder->buildActionOpenPhone('0919018791'); // build action open phone
$msgBuilder->withButton('Open Phone', $actionOpenPhone);

$actionOpenSMS = $msgBuilder->buildActionOpenSMS('0919018791', 'sms text'); // build action open sms
$msgBuilder->withButton('Open SMS', $actionOpenSMS);

$msgText = $msgBuilder->build();
// send request
$response = $zalo->post(ZaloEndPoint::API_OA_SEND_MESSAGE, $accessToken, $msgText);
$result = $response->getDecodedBody(); // result

发送图片消息

// build data
$msgBuilder = new MessageBuilder('media');
$msgBuilder->withUserId('494021888309207992');
$msgBuilder->withText('Message Image');
$msgBuilder->withAttachment('cb2ab1696b688236db79');

// add buttons (only support 5 buttons - optional)
$actionOpenUrl = $msgBuilder->buildActionOpenURL('https://wwww.google.com'); // build action open link
$msgBuilder->withButton('Open Link', $actionOpenUrl);

$actionQueryShow = $msgBuilder->buildActionQueryShow('query_show'); // build action query show
$msgBuilder->withButton('Query Show', $actionQueryShow);

$actionQueryHide = $msgBuilder->buildActionQueryHide('query_hide'); // build action query hide
$msgBuilder->withButton('Query Hide', $actionQueryHide);

$actionOpenPhone = $msgBuilder->buildActionOpenPhone('0919018791'); // build action open phone
$msgBuilder->withButton('Open Phone', $actionOpenPhone);

$actionOpenSMS = $msgBuilder->buildActionOpenSMS('0919018791', 'sms text'); // build action open sms
$msgBuilder->withButton('Open SMS', $actionOpenSMS);

$msgImage = $msgBuilder->build();
$response = $zalo->post(ZaloEndPoint::API_OA_SEND_MESSAGE, $accessToken, $msgImage);
$result = $response->getDecodedBody(); // result

发送列表消息

$msgBuilder = new MessageBuilder('list');
$msgBuilder->withUserId('494021888309207992');
$msgBuilder->withText('Message Text');

$actionOpenUrl = $msgBuilder->buildActionOpenURL('https://www.google.com');
$msgBuilder->withElement('Open Link Google', 'https://img.icons8.com/bubbles/2x/google-logo.png', 'Search engine', $actionOpenUrl);

$actionQueryShow = $msgBuilder->buildActionQueryShow('query_show');
$msgBuilder->withElement('Query Show', 'https://www.computerhope.com/jargon/q/query.jpg', '', $actionQueryShow);

$actionQueryHide = $msgBuilder->buildActionQueryHide('query_hide');
$msgBuilder->withElement('Query Hide', 'https://www.computerhope.com/jargon/q/query.jpg', '', $actionQueryHide);

$actionOpenPhone = $msgBuilder->buildActionOpenPhone('0919018791');
$msgBuilder->withElement('Open Phone', 'https://cdn.iconscout.com/icon/premium/png-256-thumb/phone-275-123408.png', '', $actionOpenPhone);

$actionOpenSMS = $msgBuilder->buildActionOpenSMS('0919018791', 'sms text');
$msgBuilder->withElement('Open SMS', 'https://cdn0.iconfinder.com/data/icons/new-design/512/42-Chat-512.png', '', $actionOpenSMS);

$msgList = $msgBuilder->build();
$response = $zalo->post(ZaloEndPoint::API_OA_SEND_MESSAGE, $accessToken, $msgList);
$result = $response->getDecodedBody(); // result

发送 Gif 消息

$msgBuilder = new MessageBuilder('media');
$msgBuilder->withUserId('494021888309207992');
$msgBuilder->withText('Message Image');
$msgBuilder->withAttachment('PWhbF13YGGi9VTkG/vHcTyoskajfj5Ve/EGsTK80XYo=');
$msgBuilder->withMediaType('gif');
$msgBuilder->withMediaSize(120, 120);
$msgImage = $msgBuilder->build();

$response = $zalo->post(ZaloEndPoint::API_OA_SEND_MESSAGE, $accessToken, $msgImage);
$result = $response->getDecodedBody(); // result

发送文件

$msgBuilder = new MessageBuilder('file');
$msgBuilder->withUserId('494021888309207992');
$msgBuilder->withFileToken('call_upload_file_api_to_get_file_token');
$msgFile = $msgBuilder->build();
$response = $zalo->post(ZaloEndPoint::API_OA_SEND_MESSAGE, $accessToken, $msgFile);
$result = $response->getDecodedBody(); // result

上传图片

$data = array('file' => new ZaloFile($filePath));
$response = $zalo->post(ZaloEndPoint::API_OA_UPLOAD_PHOTO, $accessToken, $data);
$result = $response->getDecodedBody(); // result

上传 Gif 图片

$data = array('file' => new ZaloFile($filePath));
$response = $zalo->post(ZaloEndPoint::API_OA_UPLOAD_GIF, $accessToken, $data);
$result = $response->getDecodedBody(); // result

上传 PDF 文件

$data = array('file' => new ZaloFile($filePath));
$response = $zalo->post(ZaloEndPoint::API_OA_UPLOAD_FILE, $accessToken, $data);
$result = $response->getDecodedBody(); // result

获取标签列表

$response = $zalo->get(ZaloEndPoint::API_OA_GET_LIST_TAG, $accessToken, []);
$result = $response->getDecodedBody();

删除标签

// build data
$data = array('tag_name' => 'vip');
// send request
$response = $zalo->post(ZaloEndPoint::API_OA_REMOVE_TAG, $accessToken, $data);
$result = $response->getDecodedBody();

从标签中移除关注者

// build data
$data = array(
        'user_id' => '494021888309207992',
        'tag_name' => 'vip'
);
// send request
$response = $zalo->post(ZaloEndPoint::API_OA_REMOVE_USER_FROM_TAG, $accessToken, $data);
$result = $response->getDecodedBody();

为关注者添加标签

// build data
$data = array(
        'user_id' => '494021888309207992',
        'tag_name' => 'vip'
);
// send request
$response = $zalo->post(ZaloEndPoint::API_OA_TAG_USER, $accessToken, $data);
$result = $response->getDecodedBody();

获取关注者信息

$data = ['data' => json_encode(array(
            'user_id' => '494021888309207992'
        ))];
$response = $zalo->get(ZaloEndPoint::API_OA_GET_USER_PROFILE, $accessToken, $data);
$result = $response->getDecodedBody(); // result

获取官方账号信息

$response = $zalo->get(ZaloEndPoint::API_OA_GET_PROFILE, $accessToken, []);
$result = $response->getDecodedBody(); // result

获取关注者列表

$data = ['data' => json_encode(array(
                'offset' => 0,
                'count' => 10
            ))];
$response = $this->zalo->get(ZaloEndPoint::API_OA_GET_LIST_FOLLOWER, $accessToken, $data);
$result = $response->getDecodedBody(); // result

获取最新消息列表

$data = ['data' => json_encode(array(
                'offset' => 0,
                'count' => 10
            ))];
$response = $zalo->get(ZaloEndPoint::API_OA_GET_LIST_RECENT_CHAT, $accessToken, $data);
$result = $response->getDecodedBody(); // result

获取与关注者相关的消息列表

$data = ['data' => json_encode(array(
                'user_id' => '494021888309207992',
                'offset' => 0,
                'count' => 10
            ))];
$response = $zalo->get(ZaloEndPoint::API_OA_GET_CONVERSATION, $accessToken, $data);
$result = $response->getDecodedBody(); // result

附录

代码模板：创建code verifier和code challenge

$codeVerifier = PKCEUtil::genCodeVerifier();
$codeChallenge = PKCEUtil::genCodeChallenge($codeVerifier);

启用appsecret_proof进行API验证

$zalo->setUseAppSecretProof(true);

版本

当前版本为4.0.4。我们将在下一个版本中添加更多功能。

作者

  • Zalo开发者

许可证

本项目的许可证为MIT许可。