MessagesApi.md

BumbalCommunicationAdmin\MessagesApi

All URIs are relative to https://communication.bumbal.eu/admin/v1

Method	HTTP request	Description
messageRetrieve	GET /message/{messageId}	Retrieve a Message
retrieveListMessages	PUT /message	Retrieve List of Messages

messageRetrieve

\BumbalCommunicationAdmin\Model\MessageModel messageRetrieve($message_id)

Retrieve a Message

Retrieve a Message

Example

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

// Configure API key authorization: api_key
BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$api_instance = new BumbalCommunicationAdmin\Api\MessagesApi();
$message_id = 789; // int | ID of Message to return

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

Parameters

Name	Type	Description	Notes
message_id	int	ID of Message to return

Return type

\BumbalCommunicationAdmin\Model\MessageModel

Authorization

api_key

HTTP request headers

• Content-Type: application/json, application/xml
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieveListMessages

\BumbalCommunicationAdmin\Model\MessageModel[] retrieveListMessages($arguments)

Retrieve List of Messages

Retrieve List of Messages

Example

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

// Configure API key authorization: api_key
BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// BumbalCommunicationAdmin\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$api_instance = new BumbalCommunicationAdmin\Api\MessagesApi();
$arguments = new \BumbalCommunicationAdmin\Model\MessageRetrieveListArguments(); // \BumbalCommunicationAdmin\Model\MessageRetrieveListArguments | Messages RetrieveList Arguments

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

Parameters

Name	Type	Description	Notes
arguments	\BumbalCommunicationAdmin\Model\MessageRetrieveListArguments	Messages RetrieveList Arguments

Return type

\BumbalCommunicationAdmin\Model\MessageModel[]

Authorization

api_key

HTTP request headers

• Content-Type: application/json, application/xml
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]