Skip to content

circuitid/circuitid-php

BranchesTags

Repository files navigation

circuitid

Introduction

Circuit ID® is an innovative cloud communications platform that redefines your connectivity experience. Our cutting-edge AI-powered solution seamlessly integrates calling, meetings, messaging, voicemail, fax, SIP Trunking, mobile broadband, and mobile phone services, accessible wherever you and your devices go.

Whether you are a beginner getting started with our API or an experienced developer looking for advanced features, this documentation site will serve as your comprehensive guide.

We are excited to have you on board and are confident that this documentation site will empower you to leverage the full potential of our REST API. If you have any questions or require further assistance, please don't hesitate to reach out to our support team.

Happy coding!

For more information, please visit https://www.circuitid.com/.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/circuitid/circuitid-php.git"
    }
  ],
  "require": {
    "circuitid/circuitid-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/circuitid/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AcceptedSendersApi(
    // 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
);
$acceptedsendersCreateOrPatch = new \OpenAPI\Client\CircuitID\AcceptedsendersCreateOrPatch(); // \OpenAPI\Client\CircuitID\AcceptedsendersCreateOrPatch | The JSON object that will be posted to the REST API endpoint.

try {
    $result = $apiInstance->createAcceptedSender($acceptedsendersCreateOrPatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AcceptedSendersApi->createAcceptedSender: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://cloud9.circuitid.com

Class Method HTTP request Description
AcceptedSendersApi createAcceptedSender POST /acceptedsenders Create a new object
AcceptedSendersApi findAcceptedSenders GET /acceptedsenders Find multiple objects
AcceptedSendersApi getAcceptedSender GET /acceptedsenders/{id} Get object by id
AcceptedSendersApi patchAcceptedSender PATCH /acceptedsenders/{id} Patch object's data
AcceptedSendersApi removeAcceptedSender DELETE /acceptedsenders/{id} Delete object by id
AnnouncementsApi createAnnouncement POST /announcements Create a new object
AnnouncementsApi findAnnouncements GET /announcements Find multiple objects
AnnouncementsApi getAnnouncement GET /announcements/{id} Get object by id
AnnouncementsApi patchAnnouncement PATCH /announcements/{id} Patch object's data
AnnouncementsApi removeAnnouncement DELETE /announcements/{id} Delete object by id
AppMarketplaceApi findAppMarketplace GET /appmarketplace Find multiple objects
AuthenticationApi createAuthentication POST /authentication Create a new object
CallQueueAgentsApi createCallQueueAgent POST /callqueueagents Create a new object
CallQueueAgentsApi findCallQueueAgents GET /callqueueagents Find multiple objects
CallQueueAgentsApi getCallQueueAgent GET /callqueueagents/{id} Get object by id
CallQueueAgentsApi patchCallQueueAgent PATCH /callqueueagents/{id} Patch object's data
CallQueueAgentsApi removeCallQueueAgent DELETE /callqueueagents/{id} Delete object by id
CallQueuesApi createCallQueue POST /callqueues Create a new object
CallQueuesApi findCallQueues GET /callqueues Find multiple objects
CallQueuesApi getCallQueue GET /callqueues/{id} Get object by id
CallQueuesApi patchCallQueue PATCH /callqueues/{id} Patch object's data
CallQueuesApi removeCallQueue DELETE /callqueues/{id} Delete object by id
ChatRoomsApi createChatRoom POST /chatrooms Create a new object
ChatRoomsApi findChatRooms GET /chatrooms Find multiple objects
ChatRoomsApi getChatRoom GET /chatrooms/{id} Get object by id
ChatRoomsApi patchChatRoom PATCH /chatrooms/{id} Patch object's data
ChatRoomsApi removeChatRoom DELETE /chatrooms/{id} Delete object by id
ClientsApi createClient POST /clients Create a new object
ClientsApi findClients GET /clients Find multiple objects
ClientsApi getClient GET /clients/{id} Get object by id
ClientsApi patchClient PATCH /clients/{id} Patch object's data
ClientsApi removeClient DELETE /clients/{id} Delete object by id
ConferenceNumbersApi findConferenceNumbers GET /conferencenumbers Find multiple objects
ConferenceRoomsApi createConferenceRoom POST /conferencerooms Create a new object
ConferenceRoomsApi findConferenceRooms GET /conferencerooms Find multiple objects
ConferenceRoomsApi getConferenceRoom GET /conferencerooms/{id} Get object by id
ConferenceRoomsApi patchConferenceRoom PATCH /conferencerooms/{id} Patch object's data
ConferenceRoomsApi removeConferenceRoom DELETE /conferencerooms/{id} Delete object by id
ContactsApi createContact POST /contacts Create a new object
ContactsApi findContacts GET /contacts Find multiple objects
ContactsApi getContact GET /contacts/{id} Get object by id
ContactsApi patchContact PATCH /contacts/{id} Patch object's data
ContactsApi removeContact DELETE /contacts/{id} Delete object by id
ConversationMessagesApi createConversationMessage POST /conversationmessages Create a new object
ConversationMessagesApi findConversationMessages GET /conversationmessages Find multiple objects
ConversationMessagesApi getConversationMessage GET /conversationmessages/{id} Get object by id
ConversationMessagesApi patchConversationMessage PATCH /conversationmessages/{id} Patch object's data
ConversationMessagesApi removeConversationMessage DELETE /conversationmessages/{id} Delete object by id
ConversationsApi createConversation POST /conversations Create a new object
ConversationsApi findConversations GET /conversations Find multiple objects
ConversationsApi getConversation GET /conversations/{id} Get object by id
ConversationsApi patchConversation PATCH /conversations/{id} Patch object's data
ConversationsApi removeConversation DELETE /conversations/{id} Delete object by id
CustomersApi createCustomer POST /customers Create a new object
CustomersApi findCustomers GET /customers Find multiple objects
CustomersApi getCustomer GET /customers/{id} Get object by id
CustomersApi patchCustomer PATCH /customers/{id} Patch object's data
CustomersApi removeCustomer DELETE /customers/{id} Delete object by id
DNSRecordsApi findDNSRecords GET /dnsrecords Find multiple objects
DeveloperAppSubscriptionsApi createDeveloperAppSubscription POST /developerappsubscriptions Create a new object
DeveloperAppSubscriptionsApi findDeveloperAppSubscriptions GET /developerappsubscriptions Find multiple objects
DeveloperAppSubscriptionsApi getDeveloperAppSubscription GET /developerappsubscriptions/{id} Get object by id
DeveloperAppSubscriptionsApi patchDeveloperAppSubscription PATCH /developerappsubscriptions/{id} Patch object's data
DeveloperAppSubscriptionsApi removeDeveloperAppSubscription DELETE /developerappsubscriptions/{id} Delete object by id
DeveloperAppsApi createDeveloperApp POST /developerapps Create a new object
DeveloperAppsApi findDeveloperApps GET /developerapps Find multiple objects
DeveloperAppsApi getDeveloperApp GET /developerapps/{id} Get object by id
DeveloperAppsApi patchDeveloperApp PATCH /developerapps/{id} Patch object's data
DeveloperAppsApi removeDeveloperApp DELETE /developerapps/{id} Delete object by id
DirectoriesApi createdirectory POST /directories Create a new object
DirectoriesApi findDirectories GET /directories Find multiple objects
DirectoriesApi getdirectory GET /directories/{id} Get object by id
DirectoriesApi patchdirectory PATCH /directories/{id} Patch object's data
DirectoriesApi removedirectory DELETE /directories/{id} Delete object by id
DomainsApi createDomain POST /domains Create a new object
DomainsApi findDomains GET /domains Find multiple objects
DomainsApi getDomain GET /domains/{id} Get object by id
DomainsApi patchDomain PATCH /domains/{id} Patch object's data
DomainsApi removeDomain DELETE /domains/{id} Delete object by id
FaxAccountsApi createFaxAccount POST /faxaccounts Create a new object
FaxAccountsApi findFaxAccounts GET /faxaccounts Find multiple objects
FaxAccountsApi getFaxAccount GET /faxaccounts/{id} Get object by id
FaxAccountsApi patchFaxAccount PATCH /faxaccounts/{id} Patch object's data
FaxAccountsApi removeFaxAccount DELETE /faxaccounts/{id} Delete object by id
FaxesApi createFax POST /faxes Create a new object
FaxesApi findFaxes GET /faxes Find multiple objects
FaxesApi getFax GET /faxes/{id} Get object by id
FaxesApi removeFax DELETE /faxes/{id} Delete object by id
FindNumbersApi findFindNumbers GET /findnumbers Find multiple objects
FirewallApi createFirewall POST /firewall Create a new object
FirewallApi findFirewall GET /firewall Find multiple objects
FirewallApi getFirewall GET /firewall/{id} Get object by id
FirewallApi patchFirewall PATCH /firewall/{id} Patch object's data
FirewallApi removeFirewall DELETE /firewall/{id} Delete object by id
GroupMembersApi createGroupMember POST /groupmembers Create a new object
GroupMembersApi findGroupMembers GET /groupmembers Find multiple objects
GroupMembersApi getGroupMember GET /groupmembers/{id} Get object by id
GroupMembersApi patchGroupMember PATCH /groupmembers/{id} Patch object's data
GroupMembersApi removeGroupMember DELETE /groupmembers/{id} Delete object by id
GroupsApi createGroup POST /groups Create a new object
GroupsApi findGroups GET /groups Find multiple objects
GroupsApi getGroup GET /groups/{id} Get object by id
GroupsApi patchGroup PATCH /groups/{id} Patch object's data
GroupsApi removeGroup DELETE /groups/{id} Delete object by id
HolidaysApi createHoliday POST /holidays Create a new object
HolidaysApi findHolidays GET /holidays Find multiple objects
HolidaysApi getHoliday GET /holidays/{id} Get object by id
HolidaysApi patchHoliday PATCH /holidays/{id} Patch object's data
HolidaysApi removeHoliday DELETE /holidays/{id} Delete object by id
InfoApi getInfo GET /info Get object
InvoiceItemsApi findInvoiceItems GET /invoiceitems Find multiple objects
InvoiceItemsApi getInvoiceItem GET /invoiceitems/{id} Get object by id
InvoicesApi findInvoices GET /invoices Find multiple objects
InvoicesApi getInvoice GET /invoices/{id} Get object by id
LicensesApi createLicense POST /licenses Create a new object
LicensesApi findLicenses GET /licenses Find multiple objects
LicensesApi getLicense GET /licenses/{id} Get object by id
LicensesApi patchLicense PATCH /licenses/{id} Patch object's data
LicensesApi removeLicense DELETE /licenses/{id} Delete object by id
MenuOptionsApi createMenuOption POST /menuoptions Create a new object
MenuOptionsApi findMenuOptions GET /menuoptions Find multiple objects
MenuOptionsApi getMenuOption GET /menuoptions/{id} Get object by id
MenuOptionsApi patchMenuOption PATCH /menuoptions/{id} Patch object's data
MenuOptionsApi removeMenuOption DELETE /menuoptions/{id} Delete object by id
MenusApi createMenu POST /menus Create a new object
MenusApi findMenus GET /menus Find multiple objects
MenusApi getMenu GET /menus/{id} Get object by id
MenusApi patchMenu PATCH /menus/{id} Patch object's data
MenusApi removeMenu DELETE /menus/{id} Delete object by id
MessageBrandsApi createMessageBrand POST /messagebrands Create a new object
MessageBrandsApi findMessageBrands GET /messagebrands Find multiple objects
MessageBrandsApi getMessageBrand GET /messagebrands/{id} Get object by id
MessageCampaignsApi createMessageCampaign POST /messagecampaigns Create a new object
MessageCampaignsApi findMessageCampaigns GET /messagecampaigns Find multiple objects
MessageCampaignsApi getMessageCampaign GET /messagecampaigns/{id} Get object by id
MessageCampaignsApi patchMessageCampaign PATCH /messagecampaigns/{id} Patch object's data
MessageCampaignsApi removeMessageCampaign DELETE /messagecampaigns/{id} Delete object by id
NumberPortsApi createNumberPort POST /numberports Create a new object
NumberPortsApi findNumberPorts GET /numberports Find multiple objects
NumberPortsApi getNumberPort GET /numberports/{id} Get object by id
NumbersApi findNumbers GET /numbers Find multiple objects
NumbersApi getNumber GET /numbers/{id} Get object by id
NumbersApi patchNumber PATCH /numbers/{id} Patch object's data
OfficesApi createOffice POST /offices Create a new object
OfficesApi findOffices GET /offices Find multiple objects
OfficesApi getOffice GET /offices/{id} Get object by id
OfficesApi patchOffice PATCH /offices/{id} Patch object's data
OfficesApi removeOffice DELETE /offices/{id} Delete object by id
PhoneInboundRuleActionsApi createPhoneInboundRuleAction POST /phoneinboundruleactions Create a new object
PhoneInboundRuleActionsApi findPhoneInboundRuleActions GET /phoneinboundruleactions Find multiple objects
PhoneInboundRuleActionsApi getPhoneInboundRuleAction GET /phoneinboundruleactions/{id} Get object by id
PhoneInboundRuleActionsApi patchPhoneInboundRuleAction PATCH /phoneinboundruleactions/{id} Patch object's data
PhoneInboundRuleActionsApi removePhoneInboundRuleAction DELETE /phoneinboundruleactions/{id} Delete object by id
PhoneInboundRulesApi createPhoneInboundRule POST /phoneinboundrules Create a new object
PhoneInboundRulesApi findPhoneInboundRules GET /phoneinboundrules Find multiple objects
PhoneInboundRulesApi getPhoneInboundRule GET /phoneinboundrules/{id} Get object by id
PhoneInboundRulesApi patchPhoneInboundRule PATCH /phoneinboundrules/{id} Patch object's data
PhoneInboundRulesApi removePhoneInboundRule DELETE /phoneinboundrules/{id} Delete object by id
PhoneOutboundRuleActionsApi createPhoneOutboundRuleAction POST /phoneoutboundruleactions Create a new object
PhoneOutboundRuleActionsApi findPhoneOutboundRuleActions GET /phoneoutboundruleactions Find multiple objects
PhoneOutboundRuleActionsApi getPhoneOutboundRuleAction GET /phoneoutboundruleactions/{id} Get object by id
PhoneOutboundRuleActionsApi patchPhoneOutboundRuleAction PATCH /phoneoutboundruleactions/{id} Patch object's data
PhoneOutboundRuleActionsApi removePhoneOutboundRuleAction DELETE /phoneoutboundruleactions/{id} Delete object by id
PhoneOutboundRulesApi createPhoneOutboundRule POST /phoneoutboundrules Create a new object
PhoneOutboundRulesApi findPhoneOutboundRules GET /phoneoutboundrules Find multiple objects
PhoneOutboundRulesApi getPhoneOutboundRule GET /phoneoutboundrules/{id} Get object by id
PhoneOutboundRulesApi patchPhoneOutboundRule PATCH /phoneoutboundrules/{id} Patch object's data
PhoneOutboundRulesApi removePhoneOutboundRule DELETE /phoneoutboundrules/{id} Delete object by id
RateCentersApi findRateCenters GET /ratecenters Find multiple objects
RateCentersApi getRateCenter GET /ratecenters/{id} Get object by id
ServersApi createServer POST /servers Create a new object
ServersApi findServers GET /servers Find multiple objects
ServersApi getServer GET /servers/{id} Get object by id
ServersApi patchServer PATCH /servers/{id} Patch object's data
ServersApi removeServer DELETE /servers/{id} Delete object by id
TimeSchedulesApi createTimeSchedule POST /timeschedules Create a new object
TimeSchedulesApi findTimeSchedules GET /timeschedules Find multiple objects
TimeSchedulesApi getTimeSchedule GET /timeschedules/{id} Get object by id
TimeSchedulesApi patchTimeSchedule PATCH /timeschedules/{id} Patch object's data
TimeSchedulesApi removeTimeSchedule DELETE /timeschedules/{id} Delete object by id
UserTokensApi createUserToken POST /usertokens Create a new object
UserTokensApi findUserTokens GET /usertokens Find multiple objects
UserTokensApi getUserToken GET /usertokens/{id} Get object by id
UserTokensApi patchUserToken PATCH /usertokens/{id} Patch object's data
UserTokensApi removeUserToken DELETE /usertokens/{id} Delete object by id
UsersApi createUser POST /users Create a new object
UsersApi findUsers GET /users Find multiple objects
UsersApi getUser GET /users/{id} Get object by id
UsersApi patchUser PATCH /users/{id} Patch object's data
UsersApi removeUser DELETE /users/{id} Delete object by id
VirtualExtensionsApi createVirtualExtension POST /virtualextensions Create a new object
VirtualExtensionsApi findVirtualExtensions GET /virtualextensions Find multiple objects
VirtualExtensionsApi getVirtualExtension GET /virtualextensions/{id} Get object by id
VirtualExtensionsApi patchVirtualExtension PATCH /virtualextensions/{id} Patch object's data
VirtualExtensionsApi removeVirtualExtension DELETE /virtualextensions/{id} Delete object by id
VoicemailApi findVoicemail GET /voicemail Find multiple objects
VoicemailApi getVoicemail GET /voicemail/{id} Get object by id

Models

Authorization

Authentication schemes defined for the API:

jwt

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages