# ps.module.IvrApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionCompanyCompanyIdIvrActionGet**](IvrApi.md#apiVersionCompanyCompanyIdIvrActionGet) | **GET** /api/{version}/company/{companyId}/ivr/action | [Company] Returns a list of active Menu action.
[**apiVersionCompanyCompanyIdIvrIdDelete**](IvrApi.md#apiVersionCompanyCompanyIdIvrIdDelete) | **DELETE** /api/{version}/company/{companyId}/ivr/{id} | [Company] Delete Ivr Menu
[**apiVersionCompanyCompanyIdIvrIdPut**](IvrApi.md#apiVersionCompanyCompanyIdIvrIdPut) | **PUT** /api/{version}/company/{companyId}/ivr/{id} | [Company] Update existing IVR menu
[**apiVersionCompanyCompanyIdIvrPost**](IvrApi.md#apiVersionCompanyCompanyIdIvrPost) | **POST** /api/{version}/company/{companyId}/ivr | [Company] Create IVR menu
[**apiVersionTeamTeamIdIvrActionGet**](IvrApi.md#apiVersionTeamTeamIdIvrActionGet) | **GET** /api/{version}/team/{teamId}/ivr/action | [Team] Returns a list of active Menu action.
[**apiVersionTeamTeamIdIvrIdDelete**](IvrApi.md#apiVersionTeamTeamIdIvrIdDelete) | **DELETE** /api/{version}/team/{teamId}/ivr/{id} | [Team] Delete Ivr Menu
[**apiVersionTeamTeamIdIvrIdPut**](IvrApi.md#apiVersionTeamTeamIdIvrIdPut) | **PUT** /api/{version}/team/{teamId}/ivr/{id} | [Team] Update existing IVR menu
[**apiVersionTeamTeamIdIvrPost**](IvrApi.md#apiVersionTeamTeamIdIvrPost) | **POST** /api/{version}/team/{teamId}/ivr | [Team] Create IVR menu

<a name="apiVersionCompanyCompanyIdIvrActionGet"></a>
# **apiVersionCompanyCompanyIdIvrActionGet**
> apiVersionCompanyCompanyIdIvrActionGet(companyId, version)

[Company] Returns a list of active Menu action.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let companyId = "companyId_example"; // String | The unique id of the company
let version = "version_example"; // String | 

apiInstance.apiVersionCompanyCompanyIdIvrActionGet(companyId, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| The unique id of the company | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionCompanyCompanyIdIvrIdDelete"></a>
# **apiVersionCompanyCompanyIdIvrIdDelete**
> apiVersionCompanyCompanyIdIvrIdDelete(companyId, id, version)

[Company] Delete Ivr Menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let companyId = "companyId_example"; // String | The unique id of the company
let id = "id_example"; // String | The unique id of the ivr object
let version = "version_example"; // String | 

apiInstance.apiVersionCompanyCompanyIdIvrIdDelete(companyId, id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| The unique id of the company | 
 **id** | **String**| The unique id of the ivr object | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionCompanyCompanyIdIvrIdPut"></a>
# **apiVersionCompanyCompanyIdIvrIdPut**
> apiVersionCompanyCompanyIdIvrIdPut(companyIdidversion)

[Company] Update existing IVR menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let companyId = "companyId_example"; // String | The unique id of the company
let id = "id_example"; // String | The unique id of the ivr object
let version = "version_example"; // String | 

apiInstance.apiVersionCompanyCompanyIdIvrIdPut(companyIdidversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| The unique id of the company | 
 **id** | **String**| The unique id of the ivr object | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreIVRsCompaniesCompanyUpdateIvrQuery**](PhoneSpeakServiceCoreIVRsCompaniesCompanyUpdateIvrQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionCompanyCompanyIdIvrPost"></a>
# **apiVersionCompanyCompanyIdIvrPost**
> apiVersionCompanyCompanyIdIvrPost(companyIdversion)

[Company] Create IVR menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let companyId = "companyId_example"; // String | The unique id of the company
let version = "version_example"; // String | 

apiInstance.apiVersionCompanyCompanyIdIvrPost(companyIdversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| The unique id of the company | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreIVRsCompaniesCompanyCreateIvrQuery**](PhoneSpeakServiceCoreIVRsCompaniesCompanyCreateIvrQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionTeamTeamIdIvrActionGet"></a>
# **apiVersionTeamTeamIdIvrActionGet**
> apiVersionTeamTeamIdIvrActionGet(teamId, version)

[Team] Returns a list of active Menu action.

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let teamId = "teamId_example"; // String | Team Id
let version = "version_example"; // String | 

apiInstance.apiVersionTeamTeamIdIvrActionGet(teamId, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **teamId** | **String**| Team Id | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeamTeamIdIvrIdDelete"></a>
# **apiVersionTeamTeamIdIvrIdDelete**
> apiVersionTeamTeamIdIvrIdDelete(teamId, id, version)

[Team] Delete Ivr Menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let teamId = "teamId_example"; // String | The unique id of the team
let id = "id_example"; // String | The unique id of the ivr object
let version = "version_example"; // String | 

apiInstance.apiVersionTeamTeamIdIvrIdDelete(teamId, id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **teamId** | **String**| The unique id of the team | 
 **id** | **String**| The unique id of the ivr object | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionTeamTeamIdIvrIdPut"></a>
# **apiVersionTeamTeamIdIvrIdPut**
> apiVersionTeamTeamIdIvrIdPut(teamIdidversion)

[Team] Update existing IVR menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let teamId = "teamId_example"; // String | The unique id of the team
let id = "id_example"; // String | The unique id of the ivr object
let version = "version_example"; // String | 

apiInstance.apiVersionTeamTeamIdIvrIdPut(teamIdidversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **teamId** | **String**| The unique id of the team | 
 **id** | **String**| The unique id of the ivr object | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreIVRsTeamsTeamUpdateIvrQuery**](PhoneSpeakServiceCoreIVRsTeamsTeamUpdateIvrQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionTeamTeamIdIvrPost"></a>
# **apiVersionTeamTeamIdIvrPost**
> apiVersionTeamTeamIdIvrPost(teamIdversion)

[Team] Create IVR menu

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.IvrApi();
let teamId = "teamId_example"; // String | The unique id of the team
let version = "version_example"; // String | 

apiInstance.apiVersionTeamTeamIdIvrPost(teamIdversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **teamId** | **String**| The unique id of the team | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreIVRsTeamsTeamCreateIvrQuery**](PhoneSpeakServiceCoreIVRsTeamsTeamCreateIvrQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined