voximplant/phpsdk

Voximplant HTTP API php 开发包

此包的官方仓库似乎已消失，因此该包已被冻结。

维护者

详细信息

github.com/DmitryIvaneychik/phpsdk

主页

源代码

问题

安装: 212

依赖者: 0

建议者: 0

安全性: 0

星标: 6

关注者: 4

分支: 2

公开问题: 0

dev-master 2016-12-28 09:20 UTC

Requires

Requires (Dev)

MIT 69f7eaff60635edcf8585ced3c658966bbbf311e

phpapisdkswagger

This package is not auto-updated.

Last update: 2019-06-10 10:57:05 UTC

README

Voximplant HTTP API 描述

要求

PHP 5.4.0 及以上版本

安装 & 使用

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/DmitryIvaneychik/phpsdk.git"
    }
  ],
  "require": {
    "voximplant/phpsdk": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

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

入门

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

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

// Configure API key: api_key
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');

// Configure account name: account_name
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('account_name', 'YOUR_ACCOUNT_NAME');

$api_instance = new \Voximplant\Api\AccountsAuthenticationApi();

try {
    $result = $api_instance->logon();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsAuthenticationApi->logon: ', $e->getMessage(), PHP_EOL;
}

?>

API 端点文档

所有 URI 都相对于 https://api.voximplant.com/platform_api/

类 方法 HTTP 请求 描述
AccountsAuthenticationApi logon POST /Logon
AccountsAuthenticationApi logout POST /Logout
ManagingAccountsApi chargeAccount POST /ChargeAccount
ManagingAccountsApi confirmAccountPasswordChange POST /ConfirmAccountPasswordChange
ManagingAccountsApi getAccountDocuments POST /GetAccountDocuments
ManagingAccountsApi getAccountInfo POST /GetAccountInfo
ManagingAccountsApi getCurrencyRate POST /GetCurrencyRate
ManagingAccountsApi getMoneyAmountToCharge POST /GetMoneyAmountToCharge
ManagingAccountsApi getResourcePrice POST /GetResourcePrice
ManagingAccountsApi getSubscriptionPrice POST /GetSubscriptionPrice
ManagingAccountsApi sendAccountPasswordChangeRequest POST /SendAccountPasswordChangeRequest
ManagingAccountsApi setAccountDocument POST /SetAccountDocument
ManagingAccountsApi setAccountInfo POST /SetAccountInfo
ManagingAdminRolesApi addAdminRole POST /AddAdminRole
ManagingAdminRolesApi delAdminRole POST /DelAdminRole
ManagingAdminRolesApi getAdminRoles POST /GetAdminRoles
ManagingAdminRolesApi setAdminRoleInfo POST /SetAdminRoleInfo
ManagingAdminUsersApi addAdminUser POST /AddAdminUser
ManagingAdminUsersApi attachAdminRole POST /AttachAdminRole
ManagingAdminUsersApi delAdminUser POST /DelAdminUser
ManagingAdminUsersApi getAdminUsers POST /GetAdminUsers
ManagingAdminUsersApi setAdminUserInfo POST /SetAdminUserInfo
ManagingApplicationsApi addApplication POST /AddApplication
ManagingApplicationsApi delApplication POST /DelApplication
ManagingApplicationsApi getApplications POST /GetApplications
ManagingApplicationsApi setApplicationInfo POST /SetApplicationInfo
ManagingAuthorizedIPsApi addAuthorizedAccountIP POST /AddAuthorizedAccountIP
ManagingAuthorizedIPsApi checkAuthorizedAccountIP POST /CheckAuthorizedAccountIP
ManagingAuthorizedIPsApi delAuthorizedAccountIP POST /DelAuthorizedAccountIP
ManagingAuthorizedIPsApi getAuthorizedAccountIPs POST /GetAuthorizedAccountIPs
ManagingCallListsApi appendToCallList POST /AppendToCallList
ManagingCallListsApi createCallList POST /CreateCallList
ManagingCallListsApi createManualCallList POST /CreateManualCallList
ManagingCallListsApi getCallListDetails POST /GetCallListDetails
ManagingCallListsApi 获取呼叫列表 POST /GetCallLists
ManagingCallListsApi 恢复呼叫列表 POST /RecoverCallList
ManagingCallListsApi 启动下一个呼叫任务 POST /StartNextCallTask
ManagingCallListsApi 停止呼叫列表处理 POST /StopCallListProcessing
管理呼叫者ID API 激活呼叫者ID POST /ActivateCallerID
管理呼叫者ID API 添加呼叫者ID POST /AddCallerID
管理呼叫者ID API 删除呼叫者ID POST /DelCallerID
管理呼叫者ID API 获取呼叫者ID列表 POST /GetCallerIDs
管理呼叫者ID API 验证呼叫者ID POST /VerifyCallerID
管理历史记录 API 下载历史报告 POST /DownloadHistoryReport
管理历史记录 API 获取ACD历史记录 POST /GetACDHistory
管理历史记录 API 获取呼叫历史记录 POST /GetCallHistory
管理历史记录 API 获取历史报告 POST /GetHistoryReports
管理历史记录 API 获取交易历史记录 POST /GetTransactionHistory
管理PSTN黑名单 API 添加PSTN黑名单项 POST /AddPstnBlackListItem
管理PSTN黑名单 API 删除PSTN黑名单项 POST /DelPstnBlackListItem
管理PSTN黑名单 API 获取PSTN黑名单 POST /GetPstnBlackList
管理PSTN黑名单 API 设置PSTN黑名单项 POST /SetPstnBlackListItem
管理电话号码 API 附加电话号码 POST /AttachPhoneNumber
管理电话号码 API 将电话号码绑定到应用程序 POST /BindPhoneNumberToApplication
管理电话号码 API 停用电话号码 POST /DeactivatePhoneNumber
管理电话号码 API 获取实际电话号码区域 POST /GetActualPhoneNumberRegion
管理电话号码 API 获取新电话号码 POST /GetNewPhoneNumbers
管理电话号码 API 获取电话号码类别 POST /GetPhoneNumberCategories
管理电话号码 API 获取电话号码国家州 POST /GetPhoneNumberCountryStates
管理电话号码 API 获取电话号码区域 POST /GetPhoneNumberRegions
管理电话号码 API 获取电话号码 POST /GetPhoneNumbers
管理电话号码 API 设置电话号码信息 POST /SetPhoneNumberInfo
管理推送凭证 API 添加推送凭证 POST /AddPushCredential
管理推送凭证 API 绑定推送凭证 POST /BindPushCredential
管理推送凭证 API 删除推送凭证 POST /DelPushCredential
管理推送凭证 API 获取推送凭证 POST /GetPushCredential
管理推送凭证 API 设置推送凭证 POST /SetPushCredential
管理队列 API 添加队列 POST /AddQueue
管理队列 API 删除队列 POST /DelQueue
管理队列 API 获取ACD状态 POST /GetACDState
管理队列 API 获取队列 POST /GetQueues
管理队列 API 设置队列信息 POST /SetQueueInfo
管理监管地址 API 创建监管地址 POST /CreateRegulationAddress
管理监管地址 API 获取可用监管 POST /GetAvailibleRegulations
管理监管地址 API 获取国家 POST /GetCountries
管理监管地址 API 获取区域 POST /GetRegions
管理监管地址 API 获取监管地址 POST /GetRegulationsAddress
管理监管地址 API 获取ZIP代码 POST /GetZIPCodes
管理监管地址 API 链接监管地址 POST /LinkregulationAddress
管理监管地址 API 上传地址证明 POST /UploadProofOfAddress
管理规则 API 添加规则 POST /AddRule
管理规则 API 删除规则 POST /DelRule
管理规则 API 获取规则 POST /GetRules
管理规则 API 重新排序规则 POST /ReorderRules
管理规则 API 设置规则信息 POST /SetRuleInfo
管理SIP注册 API 绑定SIP注册 POST /BindSipRegistration
管理SIP注册 API 创建SIP注册 POST /CreateSipRegistration
管理SIP注册 API 删除SIP注册 POST /DeleteSipRegistration
管理SIP注册 API 获取SIP注册 POST /GetSipRegistrations
管理SIP注册 API 更新SIP注册 POST /UpdateSipRegistration
管理SIP白名单 API 添加SIP白名单项 POST /AddSipWhiteListItem
管理SIP白名单 API 删除SIP白名单项 POST /DelSipWhiteListItem
管理SIP白名单 API 获取SIP白名单 POST /GetSipWhiteList
管理SIP白名单 API 设置SIP白名单项 POST /SetSipWhiteListItem
管理场景 API 添加场景 POST /AddScenario
管理场景 API 绑定场景 POST /BindScenario
管理场景 API 删除场景 POST /DelScenario
管理场景 API 获取场景 POST /GetScenarios
管理场景 API 重新排序场景 POST /ReorderScenarios
管理场景 API 设置场景信息 POST /SetScenarioInfo
管理场景 API 启动会议 POST /StartConference
管理场景 API startScenarios POST /StartScenarios
ManagingSkillsApi addSkill POST /AddSkill
ManagingSkillsApi bindSkill POST /BindSkill
ManagingSkillsApi delSkill POST /DelSkill
ManagingSkillsApi getSkills POST /GetSkills
ManagingSkillsApi setSkillInfo POST /SetSkillInfo
ManagingUsersApi addUser POST /AddUser
ManagingUsersApi bindUser POST /BindUser
ManagingUsersApi delUser POST /DelUser
ManagingUsersApi getUsers POST /GetUsers
ManagingUsersApi setUserInfo POST /SetUserInfo
ManagingUsersApi transferMoneyToUser POST /TransferMoneyToUser

模型文档说明

授权文档说明

account_name

  • 类型: 账户名称
  • 账户名称参数名: account_name
  • 位置: URL 查询字符串

api_key

  • 类型: API 密钥
  • API 密钥参数名: api_key
  • 位置: URL 查询字符串

作者

德米特里·伊万耶奇克 ivaneychik@zingaya.com