ycloud / ycloud-sdk-php
PHP YCloud SDK
v1.14.0
2024-09-13 07:13 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is not auto-updated.
Last update: 2024-09-27 08:00:28 UTC
README
YCloud API 围绕 REST 组织。我们的 API 设计为具有可预测的资源导向 URL,返回 JSON 响应,并使用标准的 HTTP 响应代码和动词。
安装与使用
要求
PHP 7.4 及以上版本。也应与 PHP 8.0 兼容。
Composer
要使用 Composer 安装绑定,请在您的项目目录中运行以下命令
composer require ycloud/ycloud-sdk-php
或者,将以下内容添加到 composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/ycloud-developers/ycloud-sdk-php.git" } ], "require": { "ycloud/ycloud-sdk-php": "*@dev" } }
然后运行 composer install
。
入门
请按照 安装过程 进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api_key $config = YCloud\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY'); $apiInstance = new YCloud\Client\Api\BalanceApi( // 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->retrieve(); print_r($result); } catch (Exception $e) { echo 'Exception when calling BalanceApi->retrieve: ', $e->getMessage(), PHP_EOL; }
API 端点
所有 URI 都是相对于 https://api.ycloud.com/v2
模型
- 余额
- 联系
- 联系创建请求
- 联系自定义属性
- 联系页
- 联系更新请求
- 自定义事件定义
- 自定义事件定义创建请求
- 自定义事件定义属性
- 自定义事件定义属性创建请求
- 自定义事件定义属性更新请求
- 自定义事件定义更新请求
- 自定义事件发送请求
- 电子邮件
- 电子邮件内容类型
- 电子邮件投递
- 电子邮件发送请求
- 错误
- 错误响应
- 事件
- 事件类型
- 邮箱
- 元业务账户验证状态
- 页面
- 页面游标
- 短信
- 短信入站
- 短信页
- 短信发送请求
- 取消订阅者
- 取消订阅者渠道
- 取消订阅者创建请求
- 取消订阅者页
- 取消订阅者类型
- 验证
- 验证渠道
- 验证检查
- 验证检查请求
- 验证回退
- 验证发送请求
- 验证状态
- 语音
- 语音页
- 语音发送请求
- Webhook 端点
- Webhook 端点创建请求
- Webhook 端点页
- Webhook 端点状态
- Webhook 端点更新请求
- WhatsApp API 错误
- WhatsApp 国际费率资格国家
- WhatsApp 商业账户
- WhatsApp 商业账户禁止状态
- WhatsApp 商业账户页
- WhatsApp 商业账户限制信息
- WhatsApp 商业账户审查状态
- WhatsApp 商业账户更新事件枚举
- WhatsApp 商业设置
- WhatsApp 商业设置更新请求
- WhatsApp 对话
- WhatsApp 对话来源类型
- WhatsApp 对话类型
- WhatsApp 入站消息
- WhatsApp 入站消息按钮
- WhatsApp 入站消息上下文
- WhatsApp 入站消息错误
- WhatsApp 入站消息交互
- WhatsApp 入站消息交互按钮回复
- WhatsApp 入站消息交互列表回复
- WhatsApp 入站消息位置
- WhatsApp 入站消息媒体
- WhatsApp 入站消息订单
- WhatsApp 入站消息订单产品项
- WhatsApp 入站消息推荐
- WhatsApp 入站消息推荐产品
- WhatsApp 入站消息系统
- WhatsApp 入站消息文本
- WhatsApp 入站消息类型
- WhatsApp 消息
- WhatsApp 消息联系人
- WhatsApp 消息联系人地址
- WhatsApp 消息联系人电子邮件
- WhatsApp 消息联系人姓名
- WhatsApp 消息联系人组织
- WhatsApp 消息联系人电话
- WhatsApp 消息联系人网址
- WhatsApp 消息上下文
- WhatsApp 消息交互
- WhatsApp 消息交互动作
- WhatsApp 消息交互按钮
- WhatsApp 消息交互按钮回复
- WhatsApp 消息交互动作参数
- WhatsApp 消息交互动作参数流程动作有效负载
- WhatsApp 消息交互动作部分
- WhatsApp 消息交互动作部分产品项
- WhatsApp 消息交互动作部分行
- WhatsApp 消息交互正文
- WhatsApp 消息交互页脚
- WhatsApp 消息交互标题
- WhatsApp 消息位置
- WhatsApp 消息媒体
- WhatsApp 消息反应
- WhatsApp 消息发送请求
- WhatsApp 消息状态
- WhatsApp 消息模板
- WhatsApp消息模板组件
- WhatsApp消息模板组件卡片
- WhatsApp消息模板组件卡片组件
- WhatsApp消息模板组件参数
- WhatsApp消息模板组件参数操作
- WhatsApp消息模板组件参数操作部分
- WhatsApp消息模板组件参数操作部分产品项
- WhatsApp消息模板组件参数限时优惠
- WhatsApp消息模板语言
- WhatsApp消息文本
- WhatsApp消息类型
- WhatsApp电话号码
- WhatsApp电话号码验证状态
- WhatsApp电话号码名称状态
- WhatsApp电话号码页面
- WhatsApp电话号码资料
- WhatsApp电话号码资料更新请求
- WhatsApp电话号码资料垂直
- WhatsApp电话号码质量评分
- WhatsApp电话号码质量更新事件枚举
- WhatsApp电话号码状态
- WhatsApp定价类别
- WhatsApp资料
- WhatsApp评论决策
- WhatsApp模板
- WhatsApp模板类别
- WhatsApp模板组件
- WhatsApp模板组件按钮
- WhatsApp模板组件按钮Otp类型
- WhatsApp模板组件按钮类型
- WhatsApp模板组件卡片
- WhatsApp模板组件卡片组件
- WhatsApp模板组件示例
- WhatsApp模板组件限时优惠
- WhatsApp模板创建请求
- WhatsApp模板编辑请求
- WhatsApp模板页面
- WhatsApp模板质量评分
- WhatsApp模板状态
- WhatsApp模板状态更新事件枚举
授权
api_key
- 类型: API密钥
- API密钥参数名称: X-API-Key
- 位置: HTTP头