README

Karix API lets you interact with the Karix platform using an omnichannel messaging API. It also allows you to query your account, set up webhooks and buy phone numbers.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.6 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?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;
}
?>

Documentation for API Endpoints

All URIs are relative to https://api.karix.io

Documentation For Models

• AccountListResponse
• AccountNumberListResponse
• AccountNumberResponse
• AccountResponse
• CreateAccount
• CreateMessage
• CreateMessageContent
• CreateMessageContentLocation
• CreateWebhook
• EditAccount
• EditAccountNumber
• EditWebhook
• ErrorResponse
• ErrorResponseError
• InsufficientBalanceResponse
• InsufficientBalanceResponseError
• Message
• MessageChannelDetails
• MessageChannelDetailsSms
• MessageChannelDetailsWhatsapp
• MessageContent
• MessageContentLocation
• MessageCreatedResponse
• MessageError
• MessageListResponse
• MessageResponse
• MetaResponse
• NotFoundResponse
• NotFoundResponseError
• NumberRentedResponse
• PhoneNumber
• PhoneNumberListResponse
• PhoneNumberRate
• PhoneNumberRegion
• PhoneNumberService
• RentNumber
• UnauthorizedResponse
• UnauthorizedResponseError
• WebhookListResponse
• WebhookResponse
• Account
• AccountNumber
• ArrayMetaResponse
• MetaResponseWithBalance
• ObjectMetaResponse
• Webhook

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author

support@karix.io