clicksend / clicksend-php
v5.0.79
2023-12-05 23:56 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2|^7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
- dev-master
- v5.0.79
- 5.0.78.x-dev
- 5.0.77.x-dev
- 5.0.76.x-dev
- v5.0.75
- v5.0.74
- v5.0.73
- v5.0.72
- v5.0.70
- v5.0.69
- v5.0.68
- v5.0.67
- v5.0.66
- v5.0.65
- v5.0.64
- v5.0.63
- v5.0.61
- v5.0.60
- v5.0.57
- v5.0.52
- v5.0.51
- v5.0.50
- v5.0.49
- v5.0.48
- v5.0.46
- v5.0.45
- v5.0.38
- v5.0.37
- v5.0.36
- v5.0.35
- v5.0.34
- v5.0.33
- v5.0.32
- v5.0.31
- v5.0.30
- v5.0.29
- v5.0.28
- v5.0.27
- v5.0.26
- v5.0.23
- v5.0.22
- v5.0.20
- v5.0.19
- v5.0.18
- v5.0.17
- v5.0.16
- v5.0.15
- v5.0.12
- v5.0.11
- v5.0.9
- v5.0.8
- v5.0.7
- v5.0.6
- v5.0.5
- v5.0.1
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1
- v3.0
- dev-develop
- dev-src-update
This package is not auto-updated.
Last update: 2024-09-12 11:31:34 UTC
README
这是ClickSend的官方SDK。以下是目前可用的clicksend方法列表。注意:您需要创建一个免费账户才能使用API。您可以在这里注册。
此PHP包由ClickSend Codegen项目自动生成
- API版本:3.1
- 构建包:io.swagger.codegen.v3.generators.php.PhpClientCodegen
要求
PHP 5.5及更高版本
安装与使用
Composer
要通过Composer安装绑定,请将以下内容添加到composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/git_user_id/git_repo_id.git"
}
],
"require": {
"git_user_id/git_repo_id": "*@dev"
}
}
然后运行composer install
手动安装
下载文件并包含autoload.php
require_once('/path/to/ClickSendClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照安装过程进行,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); try { $result = $apiInstance->accountGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountGet: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\Account(); // \ClickSend\Model\Account | Account model try { $result = $apiInstance->accountPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountPost: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $year = 56; // int | Year to filter by (yyyy) $month = 56; // int | Month to filter by (mm) try { $result = $apiInstance->accountUseageBySubaccountGet($year, $month); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountUseageBySubaccountGet: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\AccountVerify(); // \ClickSend\Model\AccountVerify | Account details try { $result = $apiInstance->accountVerifySendPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountVerifySendPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $activation_token = 56; // int | try { $result = $apiInstance->accountVerifyVerifyByActivationTokenPut($activation_token); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountVerifyVerifyByActivationTokenPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\ForgotPassword(); // \ClickSend\Model\ForgotPassword | try { $result = $apiInstance->forgotPasswordPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotPasswordPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\AccountForgotPasswordVerify(); // \ClickSend\Model\AccountForgotPasswordVerify | verifyPassword data try { $result = $apiInstance->forgotPasswordVerifyPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotPasswordVerifyPut: ', $e->getMessage(), PHP_EOL; } $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $body = new \ClickSend\Model\ForgotUsername(); // \ClickSend\Model\ForgotUsername | try { $result = $apiInstance->forgotUsernamePut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotUsernamePut: ', $e->getMessage(), PHP_EOL; } ?>
API端点文档
所有URI均相对于https://rest.clicksend.com/v3
模型文档
- 账户
- 账户忘记密码验证
- 账户验证
- 地址
- 附件
- 联系人
- 联系人列表
- 联系人列表导入
- 国家列表ID
- 信用卡
- 日期之前
- 投递问题
- 投递收据规则
- 电子邮件
- 电子邮件地址
- 电子邮件活动
- 电子邮件发件人
- 电子邮件收件人
- 电子邮件SMS地址
- 新电子邮件模板
- 更新电子邮件模板
- 传真消息
- 传真消息集合
- 字段
- 字段字段
- 忘记密码
- 忘记用户名
- 入站传真规则
- 入站短信规则
- 多媒体活动
- 多媒体消息
- 多媒体消息集合
- 邮政信件
- 邮政明信片
- 邮政收件人
- 转售账户
- 转售账户转账信用
- 短信活动
- 短信消息
- 短信消息集合
- 短信模板
- 去除字符串
- 子账户
- 上传文件
- URL
- 语音消息
- 语音消息集合
授权文档
基本认证
- 类型:HTTP基本认证