# TransmitsmsSdk.SMSApi

All URIs are relative to *http://api.stage.aws.burstage.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getSmsResponses**](SMSApi.md#getSmsResponses) | **GET** /get-sms-responses.json | get_sms_responses
[**getSmsStats**](SMSApi.md#getSmsStats) | **GET** /get-sms-stats.json | get_sms_stats
[**sendSms**](SMSApi.md#sendSms) | **GET** /send-sms.json | send_sms


<a name="getSmsResponses"></a>
# **getSmsResponses**
> InlineResponse2002 getSmsResponses(opts)

get_sms_responses

### Example
```javascript
var TransmitsmsSdk = require('transmitsms_sdk');
var defaultClient = TransmitsmsSdk.ApiClient.default;

// Configure HTTP basic authorization: c51ed49bcbec114ad42239009538e8ff
var c51ed49bcbec114ad42239009538e8ff = defaultClient.authentications['c51ed49bcbec114ad42239009538e8ff'];
c51ed49bcbec114ad42239009538e8ff.username = 'YOUR USERNAME';
c51ed49bcbec114ad42239009538e8ff.password = 'YOUR PASSWORD';

var apiInstance = new TransmitsmsSdk.SMSApi();

var opts = { 
  'messageId': 3.4, // Number | 
  'keywordId': 3.4, // Number | 
  'keyword': "keyword_example", // String | 
  '_number': "_number_example", // String | 
  'msisdn': "msisdn_example", // String | 
  'page': 3.4, // Number | 
  'max': 3.4, // Number | 
  'includeOriginal': true // Boolean | 
};
apiInstance.getSmsResponses(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **messageId** | **Number**|  | [optional] 
 **keywordId** | **Number**|  | [optional] 
 **keyword** | **String**|  | [optional] 
 **_number** | **String**|  | [optional] 
 **msisdn** | **String**|  | [optional] 
 **page** | **Number**|  | [optional] 
 **max** | **Number**|  | [optional] 
 **includeOriginal** | **Boolean**|  | [optional] 

### Return type

[**InlineResponse2002**](InlineResponse2002.md)

### Authorization

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

### HTTP request headers

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

<a name="getSmsStats"></a>
# **getSmsStats**
> InlineResponse2001 getSmsStats(opts)

get_sms_stats

### Example
```javascript
var TransmitsmsSdk = require('transmitsms_sdk');
var defaultClient = TransmitsmsSdk.ApiClient.default;

// Configure HTTP basic authorization: c51ed49bcbec114ad42239009538e8ff
var c51ed49bcbec114ad42239009538e8ff = defaultClient.authentications['c51ed49bcbec114ad42239009538e8ff'];
c51ed49bcbec114ad42239009538e8ff.username = 'YOUR USERNAME';
c51ed49bcbec114ad42239009538e8ff.password = 'YOUR PASSWORD';

var apiInstance = new TransmitsmsSdk.SMSApi();

var opts = { 
  'messageID': "messageID_example" // String | 
};
apiInstance.getSmsStats(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **messageID** | **String**|  | [optional] 

### Return type

[**InlineResponse2001**](InlineResponse2001.md)

### Authorization

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

### HTTP request headers

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

<a name="sendSms"></a>
# **sendSms**
> InlineResponse200 sendSms(opts)

send_sms

### Example
```javascript
var TransmitsmsSdk = require('transmitsms_sdk');
var defaultClient = TransmitsmsSdk.ApiClient.default;

// Configure HTTP basic authorization: c51ed49bcbec114ad42239009538e8ff
var c51ed49bcbec114ad42239009538e8ff = defaultClient.authentications['c51ed49bcbec114ad42239009538e8ff'];
c51ed49bcbec114ad42239009538e8ff.username = 'YOUR USERNAME';
c51ed49bcbec114ad42239009538e8ff.password = 'YOUR PASSWORD';

var apiInstance = new TransmitsmsSdk.SMSApi();

var opts = { 
  'message': "message_example", // String | 
  'to': "to_example", // String | 
  'from': "from_example", // String | 
  'sendAt': "sendAt_example", // String | 
  'listId': 3.4, // Number | 
  'dlrCallback': "dlrCallback_example", // String | 
  'replyCallback': "replyCallback_example", // String | 
  'validity': "validity_example", // String | 
  'repliesToEmail': "repliesToEmail_example", // String | 
  'fromShared': "fromShared_example", // String | 
  'countrycode': "countrycode_example" // String | 
};
apiInstance.sendSms(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **message** | **String**|  | [optional] 
 **to** | **String**|  | [optional] 
 **from** | **String**|  | [optional] 
 **sendAt** | **String**|  | [optional] 
 **listId** | **Number**|  | [optional] 
 **dlrCallback** | **String**|  | [optional] 
 **replyCallback** | **String**|  | [optional] 
 **validity** | **String**|  | [optional] 
 **repliesToEmail** | **String**|  | [optional] 
 **fromShared** | **String**|  | [optional] 
 **countrycode** | **String**|  | [optional] 

### Return type

[**InlineResponse200**](InlineResponse200.md)

### Authorization

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

### HTTP request headers

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