README

Karix API 允许您使用全渠道消息API与Karix平台交互。它还允许您查询您的账户、设置webhooks和购买电话号码。

此PHP软件包是由Swagger Codegen项目自动生成的

API版本：2.0
软件包版本：2.0.0
构建软件包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.6及更高版本

安装与使用

Composer

要通过Composer安装绑定，请在composer.json中添加以下内容

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/karixtech/karix-php.git"
    }
  ],
  "require": {
    "karixtech/karix-php": "2.0.0"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

    require_once('/path/to/karix-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装说明进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Karix\Configuration::getDefaultConfiguration()
    ->setUsername('ACCOUNT_ID')
    ->setPassword('ACCOUNT_TOKEN');

$apiInstance = new Karix\Api\MessageApi(
    // 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
);
date_default_timezone_set('UTC');
// Create Message object
$message = (new \Karix\Model\CreateMessage())
    ->setChannel("sms") //Or use "whatsapp"
    ->setSource("+1XXX2321XXX")
    ->setDestination(["+1XXX8323XXX", "+1XXX3234XXX"])
    ->setContent(["text" => "Sent from Karix PHP SDK"]);

try {
    $result = $apiInstance->sendMessage($message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessageApi->sendMessage: ', $e->getMessage(), PHP_EOL;
}
?>

API端点文档

所有URI相对于https://api.karix.io

类	方法	HTTP请求	描述
AccountsApi	createSubaccount	POST /account/	创建一个新的子账户
AccountsApi	getSubaccount	GET /account/	获取账户列表
AccountsApi	getSubaccountById	GET /account/{uid}/	获取账户详情
AccountsApi	patchSubaccount	PATCH /account/{uid}/	编辑账户
MessageApi	getMessage	GET /message/	获取发送或接收的消息列表
MessageApi	getMessageById	GET /message/{uid}/	通过ID获取消息详情。
MessageApi	sendMessage	POST /message/	向一组目的地发送消息
NumberApi	deleteNumber	DELETE /number/{num}/	从您的账户中取消租用号码
NumberApi	getNumber	GET /number/	获取与您的账户相关联的所有电话号码的详细信息。
NumberApi	getNumberDetails	GET /number/{num}/	获取号码的详细信息
NumberApi	patchNumberDetails	PATCH /number/{num}/	编辑属于您的账户的电话号码
NumberApi	rentNumber	POST /number/	租用电话号码
NumberSearchApi	searchNumber	GET /numbersearch/	查询我们库存中的电话号码。
WebhookApi	createWebhook	POST /webhook/	创建接收消息的webhooks
WebhookApi	deleteWebhookById	DELETE /webhook/{uid}/	通过ID删除webhook
WebhookApi	getWebhook	GET /webhook/	获取您的webhooks列表
WebhookApi	getWebhookById	GET /webhook/{uid}/	通过ID获取webhook
WebhookApi	patchWebhook	PATCH /webhook/{uid}/	编辑webhook

模型文档

授权文档

基本认证

类型: HTTP基本认证

作者

support@karix.io

karixtech / karix-php

维护者

详细信息