Skip to content

Latest commit

 

History

History
163 lines (115 loc) · 5.3 KB

IVRApi.md

File metadata and controls

163 lines (115 loc) · 5.3 KB
Raw

Swagger\Client\IVRApi

All URIs are relative to https://rest.paycomet.com

Method HTTP request Description
checkSession POST /v1/ivr/session-state Checks an IVR session
getSession POST /v1/ivr/get-session Creates an IVR session
sessionCancel POST /v1/ivr/session-cancel Cancel an IVR session

checkSession

\Swagger\Client\Model\InlineResponse20031 checkSession($paycomet_api_token, $body)

Checks an IVR session

check_session

Example

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

$apiInstance = new Swagger\Client\Api\IVRApi(
    // 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()
);
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)
$body = new \Swagger\Client\Model\IvrSessionstateBody(); // \Swagger\Client\Model\IvrSessionstateBody | 

try {
    $result = $apiInstance->checkSession($paycomet_api_token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IVRApi->checkSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
paycomet_api_token string PAYCOMET API key (Authorization privilege required)
body \Swagger\Client\Model\IvrSessionstateBody [optional]

Return type

\Swagger\Client\Model\InlineResponse20031

Authorization

No authorization required

HTTP request headers

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

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

getSession

\Swagger\Client\Model\InlineResponse20030 getSession($paycomet_api_token, $body)

Creates an IVR session

get_session

Example

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

$apiInstance = new Swagger\Client\Api\IVRApi(
    // 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()
);
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)
$body = new \Swagger\Client\Model\IvrGetsessionBody(); // \Swagger\Client\Model\IvrGetsessionBody | 

try {
    $result = $apiInstance->getSession($paycomet_api_token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IVRApi->getSession: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
paycomet_api_token string PAYCOMET API key (Authorization privilege required)
body \Swagger\Client\Model\IvrGetsessionBody [optional]

Return type

\Swagger\Client\Model\InlineResponse20030

Authorization

No authorization required

HTTP request headers

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

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

sessionCancel

\Swagger\Client\Model\InlineResponse20032 sessionCancel($paycomet_api_token, $body)

Cancel an IVR session

session_cancell

Example

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

$apiInstance = new Swagger\Client\Api\IVRApi(
    // 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()
);
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)
$body = new \Swagger\Client\Model\IvrSessioncancelBody(); // \Swagger\Client\Model\IvrSessioncancelBody | 

try {
    $result = $apiInstance->sessionCancel($paycomet_api_token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IVRApi->sessionCancel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
paycomet_api_token string PAYCOMET API key (Authorization privilege required)
body \Swagger\Client\Model\IvrSessioncancelBody [optional]

Return type

\Swagger\Client\Model\InlineResponse20032

Authorization

No authorization required

HTTP request headers

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

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