Reamaze PHP SDK
Back to top  

Messages

Extends \mixisLv\Reamaze\BaseApi

Class Messages

package

mixisLv\Reamaze\Api
author

Mikus Rozenbergs mikus.rozenbergs@gmail.com

Methods

__construct

__construct(\mixisLv\Reamaze\Api $api)
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$api

\mixisLv\Reamaze\Api

Creating Messages

create(string $slug, \mixisLv\Reamaze\Params\Messages\CreateParams $params) : \stdClass

$message = new \mixisLv\Reamaze\Params\Messages\CreateParams\CreateParams([ "body" => "Nullam rutrum cursus arcu, et viverra nisl finibus molestie.", "recipients" => ["recipient@example.com"], "user" => [ "name" => "Lorem Ipsum", "email" => "lorem.ipsum@example.com", ], ]); $response = $reamaze->messages->create('new-conversation', $message);

see https://www.reamaze.com/api/post_messages
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$slug

string

$params

\mixisLv\Reamaze\Params\Messages\CreateParams

Response

\stdClass

getAction

getCreateAction(string $slug) : string
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$slug

string

Response

string

getRetrieveAction

getRetrieveAction(string $slug) : string
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$slug

string

Response

string

prepareCreateParams

prepareCreateParams(\mixisLv\Reamaze\Params\Messages\CreateParams $params) : array
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$params

\mixisLv\Reamaze\Params\Messages\CreateParams

Response

array

prepareRetrieveParams

prepareRetrieveParams(\mixisLv\Reamaze\Params\Messages\RetrieveParams|null $params) : array
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$params

\mixisLv\Reamaze\Params\Messages\RetrieveParams|null

Response

array

Retrieving Messages

retrieve(\mixisLv\Reamaze\Params\Messages\RetrieveParams|null $params = null) : \stdClass

$params = new \mixisLv\Reamaze\Params\Messages\RetrieveParams\RetrieveParams(['slug'=> 'new-conversation']); $response = $reamaze->messages->retrieve($params);

see https://www.reamaze.com/api/get_messages
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$params

\mixisLv\Reamaze\Params\Messages\RetrieveParams|null

Response

\stdClass

Properties

api

api :
inherited

Type(s)