通过
搜索
搜索digs / courier-sdk-php
Courier API的PHP实现作为SDK。支持Laravel 5.8+
v0.10
2020-03-01 23:52 UTC
Requires
- php: >=7.2
- ext-curl: *
- ext-json: *
- nimbly/shuttle: ^0.3
Requires (Dev)
- php-coveralls/php-coveralls: ^2.1
- phpunit/phpunit: ^8.1
- symfony/var-dumper: ^4.2
- vimeo/psalm: ^3.3
This package is auto-updated.
Last update: 2024-09-09 12:31:31 UTC
README
Courier PHP SDK支持
- 发送API
- 消息API
- 资料API
- 偏好API
官方Courier API文档
有关请求和响应负载以及属性的完整描述，请参阅官方Courier API文档。
要求
- PHP 7.2+
- ext-curl
- ext-json
安装
composer require digs/courier-sdk-php
配置
使用您的授权和（可选）用户名实例化Courier客户端类。仅提供授权令牌将生成一个“Bearer”授权头，而提供用户名将生成一个“Basic”（base64编码）授权头
$client = new Courier("authorization-token", "username");
选项
许多方法允许向Courier端点传递可选数据。这些数据应该是键/值对的关联数组。支持的具体选项取决于调用的端点。请参阅官方Courier文档以获取更多信息。
$profile = [ "firstname" => "Johnny", "lastname" => "Appleseed", "email" => "johnny.appleseed@mail.com" ];
方法
有关请求和响应负载以及属性的完整描述，请参阅官方Courier API文档。
发送API
sendNotification(string $event, string $recipient, array $profile = [], array $data = [], array $preferences = [], array $overrides = []): object[?]
消息API
getMessage(string $message_id): object[?]
资料API
getProfile(string $recipient_id): object[?]upsertProfile(string $recipient_id, array $profile_attributes): object[?]replaceProfile(string $recipient_id, array $profile_attributes): object[?]patchProfile(string $recipient_id, array $patch): object[?]
偏好API
getPreferences(string $recipient_id, string $preferred_channel): object[?]updatePreferences(string $recipient_id, string $preferred_channel): object[?]
错误
所有不成功（非2xx）的响应都将抛出CourierRequestException。完整的响应对象可通过getResponse()方法获取。