JMessage API PHP Client
这是 JMessage REST API 的 PHP 版本封装开发包,是由极光推送官方提供的,一般支持最新的 API 功能。
对应的 REST API 文档: https://docs.jiguang.cn/jmessage/server/rest_api_im/
支持的 PHP 版本: 5.4 ~ 5.6.x, 7
Installation
使用 Composer 安装
在项目中的composer.json
文件中添加 jmessage 依赖:
"require": {
"jiguang/jmessage": "~1.1"
}
执行 $ php composer.phar install
或 $ composer install
进行安装。
直接下载源码安装
下载源代码包,解压到项目中 在项目中引入 autoload(在源码根目录下):直接下载源代码也是一种安装 SDK 的方法,不过因为有版本更新的维护问题,所以这种安装方式十分不推荐,但由于种种原因导致无法使用 Composer,所以我们也提供了这种情况下的备选方案。
require 'path_to_sdk/autoload.php';
Usage
JMessage Client 证书问题 User 用户 Admin 管理员 Blacklist 黑名单 Group 群组 Friend 好友 Resource 媒体资源 消息相关 SensitiveWord 敏感词 ChatRoom 聊天室 跨应用 ReportExamples
注意: 这只是使用样例, 不应该直接用于实际环境中!!
在项目的 examples 文件夹中有简单的使用示例代码, 开发者可以参考其中的样例快速了解该库的使用方法。
注:所下载的样例代码不可马上使用,需要在 examples/config.php
文件中填入相关的必要参数,或者设置相关环境变量,不进行这个操作则示例运行会失败。 另外为保护开发者隐私 examples/config.php
文件不在版本控制中,需要使用如下命令手动复制:
$ cp examples/config.php.example examples/config.php
示例简单使用方法
若要运行 friend_examples.php 中的示例代码:
# 假定当前目录为 JMessage 源码所在的根目录 $ php examples/friend_examples.php
当然也可编辑相关的示例文件,更改参数查看执行效果
ErrorCode
JMessage 服务器端报的错误码。有可能出现在返回值中,可在这里查询含义: https://docs.jiguang.cn/jmessage/client/im_errorcode_server/
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jpush/jmessage-api-php-client.
License
The library is available as open source under the terms of the MIT License.
版权声明:
1、该文章(资料)来源于互联网公开信息,我方只是对该内容做点评,所分享的下载地址为原作者公开地址。2、网站不提供资料下载,如需下载请到原作者页面进行下载。
3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考学习用!
4、如文档内容存在违规,或者侵犯商业秘密、侵犯著作权等,请点击“违规举报”。