Skip to content

CommentAutomationsApi.md

Latest commit

 

History

History
382 lines (257 loc) · 11.6 KB

CommentAutomationsApi.md

File metadata and controls

382 lines (257 loc) · 11.6 KB

Zernio\CommentAutomationsApi

All URIs are relative to https://zernio.com/api, except if the operation defines another base path.

Method HTTP request Description
createCommentAutomation() POST /v1/comment-automations Create comment-to-DM automation
deleteCommentAutomation() DELETE /v1/comment-automations/{automationId} Delete automation
getCommentAutomation() GET /v1/comment-automations/{automationId} Get automation details
listCommentAutomationLogs() GET /v1/comment-automations/{automationId}/logs List automation logs
listCommentAutomations() GET /v1/comment-automations List comment-to-DM automations
updateCommentAutomation() PATCH /v1/comment-automations/{automationId} Update automation settings

createCommentAutomation()

createCommentAutomation($create_comment_automation_request): \Zernio\Model\CreateCommentAutomation200Response

Create comment-to-DM automation

Create a keyword-triggered DM automation on an Instagram or Facebook post. When someone comments a matching keyword, they automatically receive a DM. Only one active automation per post is allowed.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$create_comment_automation_request = new \Zernio\Model\CreateCommentAutomationRequest(); // \Zernio\Model\CreateCommentAutomationRequest

try {
    $result = $apiInstance->createCommentAutomation($create_comment_automation_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->createCommentAutomation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_comment_automation_request \Zernio\Model\CreateCommentAutomationRequest

Return type

\Zernio\Model\CreateCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

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

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

deleteCommentAutomation()

deleteCommentAutomation($automation_id)

Delete automation

Permanently delete an automation and all its trigger logs.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$automation_id = 'automation_id_example'; // string

try {
    $apiInstance->deleteCommentAutomation($automation_id);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->deleteCommentAutomation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
automation_id string

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

getCommentAutomation()

getCommentAutomation($automation_id): \Zernio\Model\GetCommentAutomation200Response

Get automation details

Returns an automation with its configuration, stats, and recent trigger logs.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$automation_id = 'automation_id_example'; // string

try {
    $result = $apiInstance->getCommentAutomation($automation_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->getCommentAutomation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
automation_id string

Return type

\Zernio\Model\GetCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

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

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

listCommentAutomationLogs()

listCommentAutomationLogs($automation_id, $status, $limit, $skip): \Zernio\Model\ListCommentAutomationLogs200Response

List automation logs

Paginated list of every comment that triggered this automation, with send status and commenter info.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$automation_id = 'automation_id_example'; // string
$status = 'status_example'; // string | Filter by result status
$limit = 50; // int
$skip = 0; // int

try {
    $result = $apiInstance->listCommentAutomationLogs($automation_id, $status, $limit, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->listCommentAutomationLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
automation_id string
status string Filter by result status [optional]
limit int [optional] [default to 50]
skip int [optional] [default to 0]

Return type

\Zernio\Model\ListCommentAutomationLogs200Response

Authorization

bearerAuth

HTTP request headers

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

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

listCommentAutomations()

listCommentAutomations($profile_id): \Zernio\Model\ListCommentAutomations200Response

List comment-to-DM automations

List all comment-to-DM automations for a profile. Returns automations with their stats.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$profile_id = 'profile_id_example'; // string | Filter by profile. Omit to list across all profiles

try {
    $result = $apiInstance->listCommentAutomations($profile_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->listCommentAutomations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
profile_id string Filter by profile. Omit to list across all profiles [optional]

Return type

\Zernio\Model\ListCommentAutomations200Response

Authorization

bearerAuth

HTTP request headers

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

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

updateCommentAutomation()

updateCommentAutomation($automation_id, $update_comment_automation_request): \Zernio\Model\UpdateCommentAutomation200Response

Update automation settings

Update an automation's keywords, DM message, comment reply, or active status.

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = Zernio\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zernio\Api\CommentAutomationsApi(
    // 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
);
$automation_id = 'automation_id_example'; // string
$update_comment_automation_request = new \Zernio\Model\UpdateCommentAutomationRequest(); // \Zernio\Model\UpdateCommentAutomationRequest

try {
    $result = $apiInstance->updateCommentAutomation($automation_id, $update_comment_automation_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentAutomationsApi->updateCommentAutomation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
automation_id string
update_comment_automation_request \Zernio\Model\UpdateCommentAutomationRequest [optional]

Return type

\Zernio\Model\UpdateCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

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

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