ideabiz/sms

此软件包最新版本(v1.0)没有可用的许可证信息。

ideabiz/sms api 集成 PHP 辅助类

v1.0 2017-06-08 04:39 UTC

This package is not auto-updated.

Last update: 2024-09-20 20:36:39 UTC


README

#IdeaBiz PHP 示例

这将处理 API 调用,并处理令牌。如果需要,它会自动刷新现有的令牌。因此,您只需通过此 SDK 进行 API 调用即可。

##配置

  • 使 config.jsonlib/data.json 可写
  • 根据您的应用程序更改 config.json 文件的属性

要获取刷新令牌,您必须使用一次 token api 和用户名。请参阅文档

使用方法

一旦配置了 config.json,您可以将 IdeaBizAPIHandler.php 包含到您的代码中,然后调用 sendAPICall 方法

例如

include 'IdeaBizAPIHandler.php';
$auth = new IdeaBizAPIHandler();
$out = $auth->sendAPICall($url,RequestMethod::POST,$body);

参数

URL

ideabiz api 的完整 URL。例如 sms:https://ideabiz.lk/apicall/smsmessaging/v1/outbound/94777123456/requests

方法

这是一个 HTTP 方法。您可以使用 RequestMethod 枚举来使用它。它接受字符串,例如 "POST" 和 "GET"。RequestMethod 枚举包含

RequestMethod::POST
RequestMethod::GET
RequestMethod::DELETE
RequestMethod::PUT

正文

这是一个包含任何有效负载的纯文本字符串。如果您需要发送一个对象,请使用 json_encode

$out = $auth->sendAPICall($url,RequestMethod::POST,json_encode($obj));

响应

结果以数组形式返回。

成功

 $result['status'] 
 $result['statusCode'] 
 $result['time']
 $result['header']
 $result['body']

状态

这包含成功时的 "OK"。

状态码

这包含 http 状态码。例如:200,400 等。

时间

完成请求所花费的时间

头信息

服务器返回的 HTTP 头信息

正文

正文是纯文本。如果您有一个对象,可以使用 json_decode

错误

如果连接失败或发生除认证失败之外的错误,则会发生这种情况

 $result['status'] 
 $result['error'] 

状态

错误字符串值 "ERROR"

错误

这包含错误描述

异常

如果发生任何认证错误,则返回两种类型的异常

它的

AuthenticationException
ConnectionException

示例代码

请参阅 test.php