Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 2.01 KB

GroupsApi.md

File metadata and controls

62 lines (44 loc) · 2.01 KB
Raw

Swagger\Client\GroupsApi

All URIs are relative to https://slingshot.egoiapp.com/api/

Method HTTP request Description
listGroups GET /v2/groups Get All Groups

listGroups

\Swagger\Client\Model\GroupResponse[] listGroups($channel)

Get All Groups

Retrieve all groups to sort messages

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\GroupsApi(
    // 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
);
$channel = "channel_example"; // string | The channel of the groups. Can be `email` or `sms`, otherwise returns all groups.

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

Parameters

Name Type Description Notes
channel string The channel of the groups. Can be `email` or `sms`, otherwise returns all groups. [optional]

Return type

\Swagger\Client\Model\GroupResponse[]

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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