novofon/user-api-v1

Novofon API 的 PHP 类

v2.0.3 2024-09-02 11:07 UTC

This package is not auto-updated.

Last update: 2024-09-16 11:16:19 UTC


README

Novofon API 的官方 PHP 类。

允许使用所有 API 方法(包括 VoIP、PBX、回调等)。

要求

  • PHP >= 5.5.0
  • cURL
  • TLS v1.2

如何使用?

Novofon API 的官方文档在此

授权密钥在个人账户中。

安装

通过 Composer

composer require "novofon/user-api-v1"

或直接将此行添加到您的 composer.json 文件中

"novofon/user-api-v1"

通过 Git

git clone git@github.com:novofon/user-api-v1.git

\Novofon_API\Api 调用代码示例

<?php
include_once '/PATH/TO/vendor/autoload.php'; 
$api = new \Novofon_API\Api(KEY, SECRET);
try{
    $result = $api->getSipStatus('YOURSIP');
    echo $result->sip.' status: '.($result->is_online ? 'online' : 'offline');
} catch (\Novofon_API\ApiException $e) {
    echo 'Error: '.$e->getMessage();
}

所有其他示例您可以在 "示例文件" 中查看。

\Novofon_API\Client 调用代码示例

<?php

include_once '/PATH/TO/lib/Client.php';

$params = array(
    'id' => 'YOURSIP',
    'status' => 'on'
);

$api = new \Novofon_API\Client(YOUR_KEY, YOUR_SECRET);
/*
$api->call('METHOD', 'PARAMS_ARRAY', 'REQUEST_TYPE', 'FORMAT', 'IS_AUTH');
where:
- METHOD - a method API, started from /v1/ and ended by '/';
- PARAMS_ARRAY - an array of parameters to a method;
- REQUEST_TYPE: GET (default), POST, PUT, DELETE;
- FORMAT: json (default), xml;
- IS_AUTH: true (default), false - is method under authentication or not.
*/
$answer = $api->call('/v1/sip/', $params);
$answerObject = json_decode($answer);

所有其他示例您可以在 "示例文件夹中查看。