# PaycometRestApi.IVRApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**checkSession**](IVRApi.md#checkSession) | **POST** /v1/ivr/session-state | Checks an IVR session
[**getSession**](IVRApi.md#getSession) | **POST** /v1/ivr/get-session | Creates an IVR session
[**sessionCancel**](IVRApi.md#sessionCancel) | **POST** /v1/ivr/session-cancel | Cancel an IVR session

<a name="checkSession"></a>
# **checkSession**
> InlineResponse20035 checkSession(PAYCOMET_API_TOKEN, opts)

Checks an IVR session

check_session

### Example
```javascript
import {PaycometRestApi} from 'paycomet_rest_api';

let apiInstance = new PaycometRestApi.IVRApi();
let PAYCOMET_API_TOKEN = "PAYCOMET_API_TOKEN_example"; // String | PAYCOMET API key (Authorization privilege required)
let opts = { 
  'body': new PaycometRestApi.IvrSessionstateBody() // IvrSessionstateBody | 
};
apiInstance.checkSession(PAYCOMET_API_TOKEN, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **PAYCOMET_API_TOKEN** | **String**| PAYCOMET API key (Authorization privilege required) | 
 **body** | [**IvrSessionstateBody**](IvrSessionstateBody.md)|  | [optional] 

### Return type

[**InlineResponse20035**](InlineResponse20035.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getSession"></a>
# **getSession**
> InlineResponse20034 getSession(PAYCOMET_API_TOKEN, opts)

Creates an IVR session

get_session

### Example
```javascript
import {PaycometRestApi} from 'paycomet_rest_api';

let apiInstance = new PaycometRestApi.IVRApi();
let PAYCOMET_API_TOKEN = "PAYCOMET_API_TOKEN_example"; // String | PAYCOMET API key (Authorization privilege required)
let opts = { 
  'body': new PaycometRestApi.IvrGetsessionBody() // IvrGetsessionBody | 
};
apiInstance.getSession(PAYCOMET_API_TOKEN, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **PAYCOMET_API_TOKEN** | **String**| PAYCOMET API key (Authorization privilege required) | 
 **body** | [**IvrGetsessionBody**](IvrGetsessionBody.md)|  | [optional] 

### Return type

[**InlineResponse20034**](InlineResponse20034.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="sessionCancel"></a>
# **sessionCancel**
> InlineResponse20036 sessionCancel(PAYCOMET_API_TOKEN, opts)

Cancel an IVR session

session_cancell

### Example
```javascript
import {PaycometRestApi} from 'paycomet_rest_api';

let apiInstance = new PaycometRestApi.IVRApi();
let PAYCOMET_API_TOKEN = "PAYCOMET_API_TOKEN_example"; // String | PAYCOMET API key (Authorization privilege required)
let opts = { 
  'body': new PaycometRestApi.IvrSessioncancelBody() // IvrSessioncancelBody | 
};
apiInstance.sessionCancel(PAYCOMET_API_TOKEN, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **PAYCOMET_API_TOKEN** | **String**| PAYCOMET API key (Authorization privilege required) | 
 **body** | [**IvrSessioncancelBody**](IvrSessioncancelBody.md)|  | [optional] 

### Return type

[**InlineResponse20036**](InlineResponse20036.md)

### Authorization

No authorization required

### HTTP request headers

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