README

Instela API 提供了 Instela 上几乎所有方法的访问权限。[https://www.instela.com](https://www.instela.com) 。使用 PHP SDK，您可以通过 PHP 容易地访问所有 API 功能。

入门

1. 最低要求 – 要运行 SDK，您的系统需要满足 [最低要求][docs-requirements]，包括具有 PHP >= 5.5 并使用 cURL 扩展编译，以及使用 TLS 后端（例如，NSS 或 OpenSSL）编译的 cURL 7.16.2+。
2. 安装 SDK – 使用 [Composer] 是推荐安装 PHP AWS SDK 的方式。SDK 通过 [Packagist] 提供，位于 [instela/instela-php-sdk][install-packagist] 包下。
3. 使用 SDK – 请阅读此文档了解如何使用 API。

使用方法

可用的 API

• MessagesClient
  • getThreadList
  • getThread
  • sendMessage
  • getMessage

MessagesClient

\Instela\SDK\Messages\MessagesClient

此 API 用于与 Instela 消息服务进行交互。

此 API 的所有方法都需要有效的 OAuth 2.0 访问令牌。

您可以使用默认构造函数创建此 API 的新实例。

use Instela\SDK\Messages;
$client = MessagesClient(array(
 'token' => 'ACCESS_TOKEN'
));

getThreadList

获取授权用户的线程列表。

MessagesClient::getThreadList( array $args = array() ): \Instela\SDK\Model\ThreadList

示例

$threadList = $messageClient->getThreadList(array(
    'page' => 1, // Optional, default = 1
    'per_page' => '25' // Optional, default = 1
));

返回值

返回线程列表对象

getThread

获取授权用户的线程。

MessagesClient::getThread( array $args = array() ): \Instela\SDK\Model\Thread

示例

$thread = $messageClient->getThread(array(
    'u1' => 1,  // User Id of the first participant of the message thread
    'u2' => 50, // User Id of the second participant of the message thread
    'page' => 1, // Optional, default = 1
    'per_page' => '25' // Optional, default = 1
));

返回值

返回线程对象。

sendMessage

从授权用户的账户发送消息。

MessagesClient::sendMessage( array $args = array() ): \Instela\SDK\Model\Message

示例

$message = $messageClient->sendMessage(array(
    'receiver' => 1,  // User Id of the receiver
    'message' => "test message", // Message body
));

返回值

返回发送的消息。

getMessage

获取给定 ID 的消息。

MessagesClient::getMessage( array $args = array() ): \Instela\SDK\Model\Message

示例

$message = $messageClient->getMessage(array(
    'id' => 1,  // Id of the message
));

返回值

返回找到的消息。