MessagingApi.md

Bluerain\ID4iClient\MessagingApi

All URIs are relative to https://backend.id4i.de

Method	HTTP request	Description
enqueueCustomMessage	POST /api/v1/organizations/{organizationId}/messaging/enqueueCustomMessage	Enqueue a custom message
getDefaultQueue	GET /api/v1/organizations/{organizationId}/messaging
patchDefaultQueue	PATCH /api/v1/organizations/{organizationId}/messaging

enqueueCustomMessage

enqueueCustomMessage($organization_id, $request)

Enqueue a custom message

Enqueue a custom organisation message with custom data.

Example

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

// Configure API key authorization: Authorization
$config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Bluerain\ID4iClient\Api\MessagingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization_id = "organization_id_example"; // string | The organisation namespace
$request = new \Bluerain\ID4iClient\Model\SendCustomMessage(); // \Bluerain\ID4iClient\Model\SendCustomMessage | request

try {
    $apiInstance->enqueueCustomMessage($organization_id, $request);
} catch (Exception $e) {
    echo 'Exception when calling MessagingApi->enqueueCustomMessage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
organization_id	string	The organisation namespace
request	\Bluerain\ID4iClient\Model\SendCustomMessage	request

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

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

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

getDefaultQueue

\Bluerain\ID4iClient\Model\QueuePresentation getDefaultQueue($organization_id)

Example

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

// Configure API key authorization: Authorization
$config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Bluerain\ID4iClient\Api\MessagingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization_id = "organization_id_example"; // string | organizationId

try {
    $result = $apiInstance->getDefaultQueue($organization_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagingApi->getDefaultQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
organization_id	string	organizationId

Return type

\Bluerain\ID4iClient\Model\QueuePresentation

Authorization

Authorization

HTTP request headers

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

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

patchDefaultQueue

patchDefaultQueue($organization_id, $request)

Example

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

// Configure API key authorization: Authorization
$config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bluerain\ID4iClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Bluerain\ID4iClient\Api\MessagingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization_id = "organization_id_example"; // string | organizationId
$request = new \Bluerain\ID4iClient\Model\QueueUpdateRequest(); // \Bluerain\ID4iClient\Model\QueueUpdateRequest | request

try {
    $apiInstance->patchDefaultQueue($organization_id, $request);
} catch (Exception $e) {
    echo 'Exception when calling MessagingApi->patchDefaultQueue: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
organization_id	string	organizationId
request	\Bluerain\ID4iClient\Model\QueueUpdateRequest	request

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

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

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