Download the PHP package karix/karix-lib without Composer
On this page you can find all versions of the php package karix/karix-lib. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package karix-lib
karix-php
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
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Tests
To run the unit tests:
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Endpoints
All URIs are relative to https://api.karix.io
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | createSubaccount | POST /account/ | Create a new subaccount |
AccountsApi | getSubaccount | GET /account/ | Get a list of accounts |
AccountsApi | getSubaccountById | GET /account/{uid}/ | Get details of an account |
AccountsApi | patchSubaccount | PATCH /account/{uid}/ | Edit an account |
MessageApi | getMessage | GET /message/ | Get list of messages sent or received |
MessageApi | getMessageById | GET /message/{uid}/ | Get message details by id. |
MessageApi | sendMessage | POST /message/ | Send a message to a list of destinations |
NumberApi | deleteNumber | DELETE /number/{num}/ | Unrent number from your account |
NumberApi | getNumber | GET /number/ | Get details of all phone numbers linked to your account. |
NumberApi | getNumberDetails | GET /number/{num}/ | Get details of a number |
NumberApi | patchNumberDetails | PATCH /number/{num}/ | Edit phone number belonging to your account |
NumberApi | rentNumber | POST /number/ | Rent a phone number |
NumberSearchApi | searchNumber | GET /numbersearch/ | Query for phone numbers in our inventory. |
WebhookApi | createWebhook | POST /webhook/ | Create webhooks to receive Message |
WebhookApi | deleteWebhookById | DELETE /webhook/{uid}/ | Delete a webhook by ID |
WebhookApi | getWebhook | GET /webhook/ | Get a list of your webhooks |
WebhookApi | getWebhookById | GET /webhook/{uid}/ | Get a webhook by ID |
WebhookApi | patchWebhook | PATCH /webhook/{uid}/ | Edit a webhook |
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
All versions of karix-lib with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2
brick/math Version ^0.8.15