deltacore / voip-api
dev-main
2023-01-25 21:07 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-26 00:44:58 UTC
README
客户端REST API
此PHP包由Swagger Codegen项目自动生成,该项目的链接为https://github.com/swagger-api/swagger-codegen
- API版本:2.20.0
- 构建包:io.swagger.codegen.languages.PhpClientCodegen
要求
PHP 5.5及更高版本
安装与使用
Composer
要使用Composer安装绑定,请将以下内容添加到composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/GroupeOndi/deltacore/voip-api.git"
}
],
"require": {
"GroupeOndi/deltacore/voip-api": "*@dev"
}
}
然后运行composer install
手动安装
下载文件并包含autoload.php
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照安装过程进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: bearer $config = Delta\Voip\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Delta\Voip\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new Delta\Voip\Api\AuthApi( // 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 ); $username = "username_example"; // string | $password = "password_example"; // string | try { $apiInstance->postAdminAuthenticate($username, $password); } catch (Exception $e) { echo 'Exception when calling AuthApi->postAdminAuthenticate: ', $e->getMessage(), PHP_EOL; } ?>
API端点文档
所有URI相对于https:///api/client/
模型文档
- ActiveCalls
- BillableCallCollection
- BillableCallDetailed
- Calendar
- CalendarCollection
- CalendarDetailed
- CalendarPeriod
- CalendarPeriodCollection
- CalendarPeriodDetailed
- CalendarPeriodsRelSchedule
- CalendarPeriodsRelScheduleDetailed
- CalendarPeriodsRelScheduleDetailedCollection
- CallAcl
- CallAclCollection
- CallAclDetailed
- CallAclRelMatchList
- CallAclRelMatchListDetailed
- CallAclRelMatchListDetailedCollection
- CallCsvReportCollection
- CallCsvReportDetailed
- CallCsvScheduler
- CallCsvSchedulerCollection
- CallCsvSchedulerDetailed
- CallForwardSetting
- CallForwardSettingCollection
- CallForwardSettingDetailed
- CallForwardSettingDetailedCollection
- CallStats
- CompanyCollection
- CompanyDetailed
- CompanyService
- CompanyServiceCollection
- CompanyServiceDetailed
- ConditionalRoute
- ConditionalRouteCollection
- ConditionalRouteDetailed
- ConditionalRoutesCondition
- ConditionalRoutesConditionCollection
- ConditionalRoutesConditionDetailed
- ConditionalRoutesConditionWithInverseRelationships
- ConditionalRoutesConditionsRelCalendar
- ConditionalRoutesConditionsRelCalendarDetailed
- ConditionalRoutesConditionsRelCalendarDetailedCollection
- ConditionalRoutesConditionsRelMatchlist
- ConditionalRoutesConditionsRelMatchlistDetailed
- ConditionalRoutesConditionsRelMatchlistDetailedCollection
- ConditionalRoutesConditionsRelRouteLock
- ConditionalRoutesConditionsRelRouteLockDetailed
- ConditionalRoutesConditionsRelRouteLockDetailedCollection
- ConditionalRoutesConditionsRelSchedule
- ConditionalRoutesConditionsRelScheduleDetailed
- ConditionalRoutesConditionsRelScheduleDetailedCollection
- ConferenceRoom
- ConferenceRoomCollection
- ConferenceRoomDetailed
- Country
- CountryCollection
- CountryDetailed
- CountryName
- CountryZone
- Ddi
- DdiCollection
- DdiDetailed
- Extension
- ExtensionCollection
- ExtensionDetailed
- ExternalCallFilter
- ExternalCallFilterBlackList
- ExternalCallFilterBlackListDetailed
- ExternalCallFilterBlackListDetailedCollection
- ExternalCallFilterCollection
- ExternalCallFilterDetailed
- ExternalCallFilterRelCalendar
- ExternalCallFilterRelCalendarDetailed
- ExternalCallFilterRelCalendarDetailedCollection
- ExternalCallFilterRelSchedule
- ExternalCallFilterRelScheduleDetailed
- ExternalCallFilterRelScheduleDetailedCollection
- ExternalCallFilterWhiteList
- ExternalCallFilterWhiteListDetailed
- ExternalCallFilterWhiteListDetailedCollection
- ExternalCallFilterWithInverseRelationships
- Fax
- FaxCollection
- FaxDetailed
- FaxesInOutCollection
- FaxesInOutDetailed
- Feature
- FeaturesRelCompanyCollection
- FeaturesRelCompanyDetailed
- Friend
- FriendCollection
- FriendDetailed
- FriendStatus
- FriendsPattern
- FriendsPatternCollection
- FriendsPatternDetailed
- 假日日期
- 假日日期集合
- 假日日期详细信息
- 搜索组
- 搜索组集合
- 搜索组详细信息
- 搜索组与用户关系
- 搜索组与用户关系详细信息
- 搜索组与用户关系集合
- IVR
- IVR集合
- IVR详细信息
- IVR条目
- IVR条目集合
- IVR条目详细信息
- 排除的IVR分机
- 排除的IVR分机详细信息
- 排除的IVR分机集合
- 带有排除扩展的IVR
- 语言
- 语言集合
- 语言详细信息
- 语言名称
- 位置
- 位置集合
- 位置详细信息
- 语音
- 语音集合
- 语音详细信息
- 匹配列表
- 匹配列表集合
- 匹配列表详细信息
- 匹配列表模式
- 匹配列表模式集合
- 匹配列表模式详细信息
- 候持音乐
- 候持音乐集合
- 候持音乐详细信息
- 候持音乐编码文件
- 候持音乐原始文件
- 通知模板
- 出站DDI规则
- 出站DDI规则集合
- 出站DDI规则详细信息
- 出站DDI规则模式
- 出站DDI规则模式详细信息
- 出站DDI规则模式集合
- 接听组
- 接听组集合
- 接听组详细信息
- 包含用户的接听组
- 接听关系用户
- 接听关系用户详细信息
- 接听关系用户集合
- 队列
- 队列集合
- 队列详细信息
- 队列成员
- 队列成员详细信息
- 队列成员集合
- 计费计划组
- 计费计划组集合
- 计费计划组详细信息
- 计费计划价格
- 计费配置文件集合
- 计费配置文件详细信息
- 录音集合
- 录音详细信息
- 注册状态
- 注册摘要
- 住宅设备
- 住宅设备集合
- 住宅设备详细信息
- 住宅设备状态
- 零售账户
- 零售账户集合
- 零售账户详细信息
- 零售账户状态
- 路由锁定
- 路由锁定集合
- 路由锁定详细信息
- 路由标签
- 路由标签集合
- 路由标签详细信息
- 日程
- 日程集合
- 日程详细信息
- 服务
- 服务集合
- 服务详细信息
- 终端
- 终端集合
- 终端详细信息
- 终端型号
- 终端型号集合
- 终端型号详细信息
- 终端状态
- 时区
- 时区集合
- 时区详细信息
- 令牌
- 转换规则集
- 转换规则集集合
- 转换规则集详细信息
- 用户
- 用户集合
- 用户详细信息
- 用户我的资料
- 用户状态
- 用户更新我的资料
- 用户CDR
- 用户CDR集合
- 用户CDR详细信息
- 网页主题
授权文档
bearer
- 类型: API密钥
- API密钥参数名: 授权
- 位置: HTTP头